{ "openapi": "3.0.2", "info": { "description": "Cisco Intersight is a management platform delivered as a service with embedded analytics for your Cisco and\n3rd party IT infrastructure. This platform offers an intelligent level of management that enables\nIT organizations to analyze, simplify, and automate their environments in more advanced ways than the prior\ngenerations of tools. Cisco Intersight provides an integrated and intuitive management experience for\nresources in the traditional data center as well as at the edge. With flexible deployment options to address\ncomplex security needs, getting started with Intersight is quick and easy.\nCisco Intersight has deep integration with Cisco UCS and HyperFlex systems allowing for remote deployment,\nconfiguration, and ongoing maintenance. The model-based deployment works for a single system in a remote\nlocation or hundreds of systems in a data center and enables rapid, standardized configuration and deployment.\nIt also streamlines maintaining those systems whether you are working with small or very large configurations.\nThe Intersight OpenAPI document defines the complete set of properties that are returned in the\nHTTP response. From that perspective, a client can expect that no additional properties are returned,\nunless these properties are explicitly defined in the OpenAPI document.\nHowever, when a client uses an older version of the Intersight OpenAPI document, the server may\nsend additional properties because the software is more recent than the client. In that case, the client\nmay receive properties that it does not know about.\nSome generated SDKs perform a strict validation of the HTTP response body against the OpenAPI document.\nThis document was created on 2026-08-07T06:46:04Z.", "version": "1.0.11-20260807064027971", "title": "Cisco Intersight Server", "license": { "name": "Apache License, Version 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "contact": { "name": "Intersight API support", "url": "https://intersight.com/help", "email": "intersight@cisco.com" }, "x-provenance": { "method": "harvested", "authored_by": "Cisco Intersight", "harvested_by": "API Evangelist", "harvested_on": "2026-08-19", "first_party": true, "provider_published": true, "source_host": "cdn.intersight.com", "note": "Cisco publishes the full Intersight OpenAPI 3.0.2 anonymously from its CDN (27.5MB master document; 3,963 operations / 2,448 paths / 5,612 schemas) plus 11 per-service documents covering 100% of the master's paths. Byte-identity reconfirmed 2026-08-19 by SHA-256. Note intersight.com itself is a soft-404 farm \u2014 the contract is on the CDN, not the app host." }, "x-evidence": [ { "type": "source", "url": "https://cdn.intersight.com/components/an-apidocs/1.0.11-20260807064027971/model/intersight-openapi-v3-1.0.11-20260807064027971.json" }, { "type": "source", "url": "https://intersight.com/apidocs/apirefs/" } ] }, "externalDocs": { "url": "/apidocs", "description": "Online documentation for the Intersight APIs" }, "servers": [ { "url": "https://{server}", "variables": { "server": { "default": "intersight.com" } }, "description": "The Intersight URL for the cloud-based infrastructure management APIs." } ], "tags": [ { "name": "access" }, { "name": "adapter" }, { "name": "bios" }, { "name": "boot" }, { "name": "capability" }, { "name": "certificatemanagement" }, { "name": "chassis" }, { "name": "compute" }, { "name": "deviceconnector" }, { "name": "equipment" }, { "name": "fault" }, { "name": "fcpool" }, { "name": "firmware" }, { "name": "graphics" }, { "name": "inventory" }, { "name": "ipmioverlan" }, { "name": "ippool" }, { "name": "iqnpool" }, { "name": "kvm" }, { "name": "ls" }, { "name": "macpool" }, { "name": "management" }, { "name": "memory" }, { "name": "networkconfig" }, { "name": "ntp" }, { "name": "os" }, { "name": "pci" }, { "name": "power" }, { "name": "processor" }, { "name": "rack" }, { "name": "sdcard" }, { "name": "security" }, { "name": "server" }, { "name": "smtp" }, { "name": "snmp" }, { "name": "sol" }, { "name": "ssh" }, { "name": "storage" }, { "name": "syslog" }, { "name": "tam" }, { "name": "terminal" }, { "name": "thermal" }, { "name": "uuidpool" }, { "name": "vmedia" }, { "name": "vnic" }, { "name": "vrf" } ], "paths": { "/api/v1/access/IpAddresses": { "get": { "tags": [ "access" ], "summary": "Read a 'access.IpAddress' resource.", "operationId": "GetAccessIpAddressList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.access.IpAddress", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'access.IpAddress' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.IpAddress.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/access/IpAddresses/{Moid}": { "get": { "tags": [ "access" ], "summary": "Read a 'access.IpAddress' resource.", "operationId": "GetAccessIpAddressByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.access.IpAddress", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'access.IpAddress' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.IpAddress" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAccessIpAddressByMoid": { "operationId": "GetAccessIpAddressByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/IpAddresses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/access/Policies": { "get": { "tags": [ "access" ], "summary": "Read a 'access.Policy' resource.", "operationId": "GetAccessPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IMC Access policies", "PRIVSET.View Server Profiles", "READ.access.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'access.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "access" ], "summary": "Create a 'access.Policy' resource.", "operationId": "CreateAccessPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.access.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit IMC Access policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'access.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'access.Policy' resource was created as requested. The 'access.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } } }, "links": { "GetAccessPolicyByMoid": { "operationId": "GetAccessPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/access/Policies/{Moid}": { "get": { "tags": [ "access" ], "summary": "Read a 'access.Policy' resource.", "operationId": "GetAccessPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IMC Access policies", "PRIVSET.View Server Profiles", "READ.access.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'access.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAccessPolicyByMoid": { "operationId": "GetAccessPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "access" ], "summary": "Update a 'access.Policy' resource.", "operationId": "UpdateAccessPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IMC Access policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.access.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'access.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'access.Policy' resource was modified as requested. The 'access.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } } }, "links": { "GetAccessPolicyByMoid": { "operationId": "GetAccessPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "access" ], "summary": "Update a 'access.Policy' resource.", "operationId": "PatchAccessPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IMC Access policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.access.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'access.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'access.Policy' resource was patched as requested. The 'access.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.Policy" } } }, "links": { "GetAccessPolicyByMoid": { "operationId": "GetAccessPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "access" ], "summary": "Delete a 'access.Policy' resource.", "operationId": "DeleteAccessPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.access.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete IMC Access policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/access/PolicyInventories": { "get": { "tags": [ "access" ], "summary": "Read a 'access.PolicyInventory' resource.", "operationId": "GetAccessPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IMC Access policies", "PRIVSET.View Server Profiles", "READ.access.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'access.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/access/PolicyInventories/{Moid}": { "get": { "tags": [ "access" ], "summary": "Read a 'access.PolicyInventory' resource.", "operationId": "GetAccessPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IMC Access policies", "PRIVSET.View Server Profiles", "READ.access.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'access.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/access.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAccessPolicyInventoryByMoid": { "operationId": "GetAccessPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/access/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/ConfigPolicies": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.ConfigPolicy' resource.", "operationId": "GetAdapterConfigPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Adapter Configuration policies", "PRIVSET.View Server Profiles", "READ.adapter.ConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.ConfigPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "adapter" ], "summary": "Create a 'adapter.ConfigPolicy' resource.", "operationId": "CreateAdapterConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.adapter.ConfigPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Adapter Configuration policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'adapter.ConfigPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was created as requested. The 'adapter.ConfigPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } } }, "links": { "GetAdapterConfigPolicyByMoid": { "operationId": "GetAdapterConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/ConfigPolicies/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.ConfigPolicy' resource.", "operationId": "GetAdapterConfigPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Adapter Configuration policies", "PRIVSET.View Server Profiles", "READ.adapter.ConfigPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.ConfigPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterConfigPolicyByMoid": { "operationId": "GetAdapterConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "adapter" ], "summary": "Update a 'adapter.ConfigPolicy' resource.", "operationId": "UpdateAdapterConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Adapter Configuration policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.ConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.ConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was modified as requested. The 'adapter.ConfigPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } } }, "links": { "GetAdapterConfigPolicyByMoid": { "operationId": "GetAdapterConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "adapter" ], "summary": "Update a 'adapter.ConfigPolicy' resource.", "operationId": "PatchAdapterConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Adapter Configuration policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.ConfigPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.ConfigPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.ConfigPolicy' resource was patched as requested. The 'adapter.ConfigPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ConfigPolicy" } } }, "links": { "GetAdapterConfigPolicyByMoid": { "operationId": "GetAdapterConfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ConfigPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "adapter" ], "summary": "Delete a 'adapter.ConfigPolicy' resource.", "operationId": "DeleteAdapterConfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.adapter.ConfigPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Adapter Configuration policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/ExtEthInterfaces": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.ExtEthInterface' resource.", "operationId": "GetAdapterExtEthInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.ExtEthInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.ExtEthInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ExtEthInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/ExtEthInterfaces/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.ExtEthInterface' resource.", "operationId": "GetAdapterExtEthInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.ExtEthInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.ExtEthInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.ExtEthInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterExtEthInterfaceByMoid": { "operationId": "GetAdapterExtEthInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/ExtEthInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostEthInterfaces": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostEthInterface' resource.", "operationId": "GetAdapterHostEthInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostEthInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.HostEthInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostEthInterfaces/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostEthInterface' resource.", "operationId": "GetAdapterHostEthInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostEthInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.HostEthInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterHostEthInterfaceByMoid": { "operationId": "GetAdapterHostEthInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostEthInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "adapter" ], "summary": "Update a 'adapter.HostEthInterface' resource.", "operationId": "UpdateAdapterHostEthInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.HostEthInterface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.HostEthInterface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.HostEthInterface' resource was modified as requested. The 'adapter.HostEthInterface' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface" } } }, "links": { "GetAdapterHostEthInterfaceByMoid": { "operationId": "GetAdapterHostEthInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostEthInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "adapter" ], "summary": "Update a 'adapter.HostEthInterface' resource.", "operationId": "PatchAdapterHostEthInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.HostEthInterface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.HostEthInterface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.HostEthInterface' resource was patched as requested. The 'adapter.HostEthInterface' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostEthInterface" } } }, "links": { "GetAdapterHostEthInterfaceByMoid": { "operationId": "GetAdapterHostEthInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostEthInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostFcInterfaces": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostFcInterface' resource.", "operationId": "GetAdapterHostFcInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostFcInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.HostFcInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostFcInterfaces/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostFcInterface' resource.", "operationId": "GetAdapterHostFcInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostFcInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.HostFcInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterHostFcInterfaceByMoid": { "operationId": "GetAdapterHostFcInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostFcInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "adapter" ], "summary": "Update a 'adapter.HostFcInterface' resource.", "operationId": "UpdateAdapterHostFcInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.HostFcInterface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.HostFcInterface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.HostFcInterface' resource was modified as requested. The 'adapter.HostFcInterface' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface" } } }, "links": { "GetAdapterHostFcInterfaceByMoid": { "operationId": "GetAdapterHostFcInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostFcInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "adapter" ], "summary": "Update a 'adapter.HostFcInterface' resource.", "operationId": "PatchAdapterHostFcInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.adapter.HostFcInterface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'adapter.HostFcInterface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'adapter.HostFcInterface' resource was patched as requested. The 'adapter.HostFcInterface' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostFcInterface" } } }, "links": { "GetAdapterHostFcInterfaceByMoid": { "operationId": "GetAdapterHostFcInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostFcInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostIscsiInterfaces": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostIscsiInterface' resource.", "operationId": "GetAdapterHostIscsiInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostIscsiInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.HostIscsiInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostIscsiInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/HostIscsiInterfaces/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.HostIscsiInterface' resource.", "operationId": "GetAdapterHostIscsiInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.HostIscsiInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.HostIscsiInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.HostIscsiInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterHostIscsiInterfaceByMoid": { "operationId": "GetAdapterHostIscsiInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/HostIscsiInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/Units": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.Unit' resource.", "operationId": "GetAdapterUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.Unit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.Unit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/Units/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.Unit' resource.", "operationId": "GetAdapterUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.Unit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.Unit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterUnitByMoid": { "operationId": "GetAdapterUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/UnitExpanders": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.UnitExpander' resource.", "operationId": "GetAdapterUnitExpanderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.UnitExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'adapter.UnitExpander' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.UnitExpander.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/adapter/UnitExpanders/{Moid}": { "get": { "tags": [ "adapter" ], "summary": "Read a 'adapter.UnitExpander' resource.", "operationId": "GetAdapterUnitExpanderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.adapter.UnitExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'adapter.UnitExpander' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adapter.UnitExpander" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetAdapterUnitExpanderByMoid": { "operationId": "GetAdapterUnitExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/adapter/UnitExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/BootDevices": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.BootDevice' resource.", "operationId": "GetBiosBootDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.BootDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.BootDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/BootDevices/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.BootDevice' resource.", "operationId": "GetBiosBootDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.BootDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.BootDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosBootDeviceByMoid": { "operationId": "GetBiosBootDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/BootModes": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.BootMode' resource.", "operationId": "GetBiosBootModeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.BootMode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.BootMode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/BootModes/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.BootMode' resource.", "operationId": "GetBiosBootModeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.BootMode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.BootMode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosBootModeByMoid": { "operationId": "GetBiosBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "bios" ], "summary": "Update a 'bios.BootMode' resource.", "operationId": "UpdateBiosBootMode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.bios.BootMode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.BootMode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.BootMode' resource was modified as requested. The 'bios.BootMode' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode" } } }, "links": { "GetBiosBootModeByMoid": { "operationId": "GetBiosBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "bios" ], "summary": "Update a 'bios.BootMode' resource.", "operationId": "PatchBiosBootMode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.bios.BootMode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.BootMode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.BootMode' resource was patched as requested. The 'bios.BootMode' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.BootMode" } } }, "links": { "GetBiosBootModeByMoid": { "operationId": "GetBiosBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/BootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/Policies": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.Policy' resource.", "operationId": "GetBiosPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only BIOS policies", "PRIVSET.View Server Profiles", "READ.bios.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "bios" ], "summary": "Create a 'bios.Policy' resource.", "operationId": "CreateBiosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.bios.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit BIOS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'bios.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Policy' resource was created as requested. The 'bios.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } } }, "links": { "GetBiosPolicyByMoid": { "operationId": "GetBiosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/Policies/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.Policy' resource.", "operationId": "GetBiosPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only BIOS policies", "PRIVSET.View Server Profiles", "READ.bios.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosPolicyByMoid": { "operationId": "GetBiosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "bios" ], "summary": "Update a 'bios.Policy' resource.", "operationId": "UpdateBiosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit BIOS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.bios.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Policy' resource was modified as requested. The 'bios.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } } }, "links": { "GetBiosPolicyByMoid": { "operationId": "GetBiosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "bios" ], "summary": "Update a 'bios.Policy' resource.", "operationId": "PatchBiosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit BIOS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.bios.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Policy' resource was patched as requested. The 'bios.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Policy" } } }, "links": { "GetBiosPolicyByMoid": { "operationId": "GetBiosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "bios" ], "summary": "Delete a 'bios.Policy' resource.", "operationId": "DeleteBiosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.bios.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete BIOS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/SystemBootOrders": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.SystemBootOrder' resource.", "operationId": "GetBiosSystemBootOrderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.SystemBootOrder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.SystemBootOrder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.SystemBootOrder.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/SystemBootOrders/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.SystemBootOrder' resource.", "operationId": "GetBiosSystemBootOrderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.SystemBootOrder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.SystemBootOrder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.SystemBootOrder" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosSystemBootOrderByMoid": { "operationId": "GetBiosSystemBootOrderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/SystemBootOrders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/TokenSettings": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.TokenSettings' resource.", "operationId": "GetBiosTokenSettingsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.TokenSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.TokenSettings' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.TokenSettings.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/TokenSettings/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.TokenSettings' resource.", "operationId": "GetBiosTokenSettingsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.TokenSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.TokenSettings' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.TokenSettings" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosTokenSettingsByMoid": { "operationId": "GetBiosTokenSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/TokenSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/Units": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.Unit' resource.", "operationId": "GetBiosUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.Unit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/Units/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.Unit' resource.", "operationId": "GetBiosUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.Unit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosUnitByMoid": { "operationId": "GetBiosUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "bios" ], "summary": "Update a 'bios.Unit' resource.", "operationId": "UpdateBiosUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.bios.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Unit' resource was modified as requested. The 'bios.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit" } } }, "links": { "GetBiosUnitByMoid": { "operationId": "GetBiosUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "bios" ], "summary": "Update a 'bios.Unit' resource.", "operationId": "PatchBiosUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.bios.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'bios.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'bios.Unit' resource was patched as requested. The 'bios.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.Unit" } } }, "links": { "GetBiosUnitByMoid": { "operationId": "GetBiosUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/VfSelectMemoryRasConfigurations": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.VfSelectMemoryRasConfiguration' resource.", "operationId": "GetBiosVfSelectMemoryRasConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.VfSelectMemoryRasConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'bios.VfSelectMemoryRasConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/bios/VfSelectMemoryRasConfigurations/{Moid}": { "get": { "tags": [ "bios" ], "summary": "Read a 'bios.VfSelectMemoryRasConfiguration' resource.", "operationId": "GetBiosVfSelectMemoryRasConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.bios.VfSelectMemoryRasConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'bios.VfSelectMemoryRasConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBiosVfSelectMemoryRasConfigurationByMoid": { "operationId": "GetBiosVfSelectMemoryRasConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/bios/VfSelectMemoryRasConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/CddDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.CddDevice' resource.", "operationId": "GetBootCddDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.CddDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.CddDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/CddDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.CddDevice' resource.", "operationId": "GetBootCddDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.CddDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.CddDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootCddDeviceByMoid": { "operationId": "GetBootCddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/CddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.CddDevice' resource.", "operationId": "UpdateBootCddDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.CddDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.CddDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.CddDevice' resource was modified as requested. The 'boot.CddDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice" } } }, "links": { "GetBootCddDeviceByMoid": { "operationId": "GetBootCddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/CddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.CddDevice' resource.", "operationId": "PatchBootCddDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.CddDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.CddDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.CddDevice' resource was patched as requested. The 'boot.CddDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.CddDevice" } } }, "links": { "GetBootCddDeviceByMoid": { "operationId": "GetBootCddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/CddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/DeviceBootModes": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.DeviceBootMode' resource.", "operationId": "GetBootDeviceBootModeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.DeviceBootMode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.DeviceBootMode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/DeviceBootModes/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.DeviceBootMode' resource.", "operationId": "GetBootDeviceBootModeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.DeviceBootMode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.DeviceBootMode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootDeviceBootModeByMoid": { "operationId": "GetBootDeviceBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.DeviceBootMode' resource.", "operationId": "UpdateBootDeviceBootMode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.DeviceBootMode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.DeviceBootMode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootMode' resource was modified as requested. The 'boot.DeviceBootMode' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode" } } }, "links": { "GetBootDeviceBootModeByMoid": { "operationId": "GetBootDeviceBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.DeviceBootMode' resource.", "operationId": "PatchBootDeviceBootMode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.DeviceBootMode" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.DeviceBootMode' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootMode' resource was patched as requested. The 'boot.DeviceBootMode' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootMode" } } }, "links": { "GetBootDeviceBootModeByMoid": { "operationId": "GetBootDeviceBootModeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootModes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/DeviceBootSecurities": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.DeviceBootSecurity' resource.", "operationId": "GetBootDeviceBootSecurityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.DeviceBootSecurity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.DeviceBootSecurity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/DeviceBootSecurities/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.DeviceBootSecurity' resource.", "operationId": "GetBootDeviceBootSecurityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.DeviceBootSecurity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.DeviceBootSecurity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootDeviceBootSecurityByMoid": { "operationId": "GetBootDeviceBootSecurityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootSecurities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.DeviceBootSecurity' resource.", "operationId": "UpdateBootDeviceBootSecurity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.DeviceBootSecurity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.DeviceBootSecurity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootSecurity' resource was modified as requested. The 'boot.DeviceBootSecurity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } } }, "links": { "GetBootDeviceBootSecurityByMoid": { "operationId": "GetBootDeviceBootSecurityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootSecurities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.DeviceBootSecurity' resource.", "operationId": "PatchBootDeviceBootSecurity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.DeviceBootSecurity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.DeviceBootSecurity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.DeviceBootSecurity' resource was patched as requested. The 'boot.DeviceBootSecurity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } } }, "links": { "GetBootDeviceBootSecurityByMoid": { "operationId": "GetBootDeviceBootSecurityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/DeviceBootSecurities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/HddDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.HddDevice' resource.", "operationId": "GetBootHddDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.HddDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.HddDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/HddDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.HddDevice' resource.", "operationId": "GetBootHddDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.HddDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.HddDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootHddDeviceByMoid": { "operationId": "GetBootHddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/HddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.HddDevice' resource.", "operationId": "UpdateBootHddDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.HddDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.HddDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.HddDevice' resource was modified as requested. The 'boot.HddDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice" } } }, "links": { "GetBootHddDeviceByMoid": { "operationId": "GetBootHddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/HddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.HddDevice' resource.", "operationId": "PatchBootHddDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.HddDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.HddDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.HddDevice' resource was patched as requested. The 'boot.HddDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.HddDevice" } } }, "links": { "GetBootHddDeviceByMoid": { "operationId": "GetBootHddDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/HddDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/IscsiDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.IscsiDevice' resource.", "operationId": "GetBootIscsiDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.IscsiDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.IscsiDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/IscsiDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.IscsiDevice' resource.", "operationId": "GetBootIscsiDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.IscsiDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.IscsiDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootIscsiDeviceByMoid": { "operationId": "GetBootIscsiDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/IscsiDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.IscsiDevice' resource.", "operationId": "UpdateBootIscsiDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.IscsiDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.IscsiDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.IscsiDevice' resource was modified as requested. The 'boot.IscsiDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice" } } }, "links": { "GetBootIscsiDeviceByMoid": { "operationId": "GetBootIscsiDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/IscsiDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.IscsiDevice' resource.", "operationId": "PatchBootIscsiDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.IscsiDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.IscsiDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.IscsiDevice' resource was patched as requested. The 'boot.IscsiDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.IscsiDevice" } } }, "links": { "GetBootIscsiDeviceByMoid": { "operationId": "GetBootIscsiDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/IscsiDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/NvmeDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.NvmeDevice' resource.", "operationId": "GetBootNvmeDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.NvmeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.NvmeDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/NvmeDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.NvmeDevice' resource.", "operationId": "GetBootNvmeDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.NvmeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.NvmeDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootNvmeDeviceByMoid": { "operationId": "GetBootNvmeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/NvmeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.NvmeDevice' resource.", "operationId": "UpdateBootNvmeDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.NvmeDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.NvmeDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.NvmeDevice' resource was modified as requested. The 'boot.NvmeDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice" } } }, "links": { "GetBootNvmeDeviceByMoid": { "operationId": "GetBootNvmeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/NvmeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.NvmeDevice' resource.", "operationId": "PatchBootNvmeDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.NvmeDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.NvmeDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.NvmeDevice' resource was patched as requested. The 'boot.NvmeDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.NvmeDevice" } } }, "links": { "GetBootNvmeDeviceByMoid": { "operationId": "GetBootNvmeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/NvmeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PchStorageDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PchStorageDevice' resource.", "operationId": "GetBootPchStorageDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.PchStorageDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.PchStorageDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PchStorageDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PchStorageDevice' resource.", "operationId": "GetBootPchStorageDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.PchStorageDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.PchStorageDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootPchStorageDeviceByMoid": { "operationId": "GetBootPchStorageDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PchStorageDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.PchStorageDevice' resource.", "operationId": "UpdateBootPchStorageDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.PchStorageDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PchStorageDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PchStorageDevice' resource was modified as requested. The 'boot.PchStorageDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice" } } }, "links": { "GetBootPchStorageDeviceByMoid": { "operationId": "GetBootPchStorageDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PchStorageDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.PchStorageDevice' resource.", "operationId": "PatchBootPchStorageDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.PchStorageDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PchStorageDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PchStorageDevice' resource was patched as requested. The 'boot.PchStorageDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PchStorageDevice" } } }, "links": { "GetBootPchStorageDeviceByMoid": { "operationId": "GetBootPchStorageDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PchStorageDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PrecisionPolicies": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PrecisionPolicy' resource.", "operationId": "GetBootPrecisionPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Boot Order policies", "PRIVSET.View Server Profiles", "READ.boot.PrecisionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.PrecisionPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Create a 'boot.PrecisionPolicy' resource.", "operationId": "CreateBootPrecisionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.boot.PrecisionPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Boot Order policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'boot.PrecisionPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was created as requested. The 'boot.PrecisionPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } } }, "links": { "GetBootPrecisionPolicyByMoid": { "operationId": "GetBootPrecisionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PrecisionPolicies/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PrecisionPolicy' resource.", "operationId": "GetBootPrecisionPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Boot Order policies", "PRIVSET.View Server Profiles", "READ.boot.PrecisionPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.PrecisionPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootPrecisionPolicyByMoid": { "operationId": "GetBootPrecisionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.PrecisionPolicy' resource.", "operationId": "UpdateBootPrecisionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Boot Order policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.boot.PrecisionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PrecisionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was modified as requested. The 'boot.PrecisionPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } } }, "links": { "GetBootPrecisionPolicyByMoid": { "operationId": "GetBootPrecisionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.PrecisionPolicy' resource.", "operationId": "PatchBootPrecisionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Boot Order policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.boot.PrecisionPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PrecisionPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PrecisionPolicy' resource was patched as requested. The 'boot.PrecisionPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PrecisionPolicy" } } }, "links": { "GetBootPrecisionPolicyByMoid": { "operationId": "GetBootPrecisionPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PrecisionPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "boot" ], "summary": "Delete a 'boot.PrecisionPolicy' resource.", "operationId": "DeleteBootPrecisionPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.boot.PrecisionPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Boot Order policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PxeDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PxeDevice' resource.", "operationId": "GetBootPxeDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.PxeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.PxeDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/PxeDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.PxeDevice' resource.", "operationId": "GetBootPxeDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.PxeDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.PxeDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootPxeDeviceByMoid": { "operationId": "GetBootPxeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PxeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.PxeDevice' resource.", "operationId": "UpdateBootPxeDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.PxeDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PxeDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PxeDevice' resource was modified as requested. The 'boot.PxeDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice" } } }, "links": { "GetBootPxeDeviceByMoid": { "operationId": "GetBootPxeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PxeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.PxeDevice' resource.", "operationId": "PatchBootPxeDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.PxeDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.PxeDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.PxeDevice' resource was patched as requested. The 'boot.PxeDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.PxeDevice" } } }, "links": { "GetBootPxeDeviceByMoid": { "operationId": "GetBootPxeDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/PxeDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/SanDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.SanDevice' resource.", "operationId": "GetBootSanDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.SanDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.SanDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/SanDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.SanDevice' resource.", "operationId": "GetBootSanDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.SanDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.SanDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootSanDeviceByMoid": { "operationId": "GetBootSanDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SanDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.SanDevice' resource.", "operationId": "UpdateBootSanDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.SanDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.SanDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.SanDevice' resource was modified as requested. The 'boot.SanDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice" } } }, "links": { "GetBootSanDeviceByMoid": { "operationId": "GetBootSanDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SanDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.SanDevice' resource.", "operationId": "PatchBootSanDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.SanDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.SanDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.SanDevice' resource was patched as requested. The 'boot.SanDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SanDevice" } } }, "links": { "GetBootSanDeviceByMoid": { "operationId": "GetBootSanDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SanDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/SdDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.SdDevice' resource.", "operationId": "GetBootSdDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.SdDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.SdDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/SdDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.SdDevice' resource.", "operationId": "GetBootSdDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.SdDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.SdDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootSdDeviceByMoid": { "operationId": "GetBootSdDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SdDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.SdDevice' resource.", "operationId": "UpdateBootSdDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.SdDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.SdDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.SdDevice' resource was modified as requested. The 'boot.SdDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice" } } }, "links": { "GetBootSdDeviceByMoid": { "operationId": "GetBootSdDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SdDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.SdDevice' resource.", "operationId": "PatchBootSdDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.SdDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.SdDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.SdDevice' resource was patched as requested. The 'boot.SdDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.SdDevice" } } }, "links": { "GetBootSdDeviceByMoid": { "operationId": "GetBootSdDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/SdDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/UefiShellDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.UefiShellDevice' resource.", "operationId": "GetBootUefiShellDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.UefiShellDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.UefiShellDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/UefiShellDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.UefiShellDevice' resource.", "operationId": "GetBootUefiShellDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.UefiShellDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.UefiShellDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootUefiShellDeviceByMoid": { "operationId": "GetBootUefiShellDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UefiShellDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.UefiShellDevice' resource.", "operationId": "UpdateBootUefiShellDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.UefiShellDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.UefiShellDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.UefiShellDevice' resource was modified as requested. The 'boot.UefiShellDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice" } } }, "links": { "GetBootUefiShellDeviceByMoid": { "operationId": "GetBootUefiShellDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UefiShellDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.UefiShellDevice' resource.", "operationId": "PatchBootUefiShellDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.UefiShellDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.UefiShellDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.UefiShellDevice' resource was patched as requested. The 'boot.UefiShellDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UefiShellDevice" } } }, "links": { "GetBootUefiShellDeviceByMoid": { "operationId": "GetBootUefiShellDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UefiShellDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/UsbDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.UsbDevice' resource.", "operationId": "GetBootUsbDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.UsbDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.UsbDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/UsbDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.UsbDevice' resource.", "operationId": "GetBootUsbDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.UsbDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.UsbDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootUsbDeviceByMoid": { "operationId": "GetBootUsbDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UsbDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.UsbDevice' resource.", "operationId": "UpdateBootUsbDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.UsbDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.UsbDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.UsbDevice' resource was modified as requested. The 'boot.UsbDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice" } } }, "links": { "GetBootUsbDeviceByMoid": { "operationId": "GetBootUsbDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UsbDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.UsbDevice' resource.", "operationId": "PatchBootUsbDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.UsbDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.UsbDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.UsbDevice' resource was patched as requested. The 'boot.UsbDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.UsbDevice" } } }, "links": { "GetBootUsbDeviceByMoid": { "operationId": "GetBootUsbDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/UsbDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/VmediaDevices": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.VmediaDevice' resource.", "operationId": "GetBootVmediaDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.VmediaDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'boot.VmediaDevice' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/boot/VmediaDevices/{Moid}": { "get": { "tags": [ "boot" ], "summary": "Read a 'boot.VmediaDevice' resource.", "operationId": "GetBootVmediaDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.boot.VmediaDevice", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'boot.VmediaDevice' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetBootVmediaDeviceByMoid": { "operationId": "GetBootVmediaDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/VmediaDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "boot" ], "summary": "Update a 'boot.VmediaDevice' resource.", "operationId": "UpdateBootVmediaDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.VmediaDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.VmediaDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.VmediaDevice' resource was modified as requested. The 'boot.VmediaDevice' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice" } } }, "links": { "GetBootVmediaDeviceByMoid": { "operationId": "GetBootVmediaDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/VmediaDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "boot" ], "summary": "Update a 'boot.VmediaDevice' resource.", "operationId": "PatchBootVmediaDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.boot.VmediaDevice" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'boot.VmediaDevice' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'boot.VmediaDevice' resource was patched as requested. The 'boot.VmediaDevice' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/boot.VmediaDevice" } } }, "links": { "GetBootVmediaDeviceByMoid": { "operationId": "GetBootVmediaDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/boot/VmediaDevices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ActionsMetaData": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ActionsMetaData' resource.", "operationId": "GetCapabilityActionsMetaDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ActionsMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ActionsMetaData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ActionsMetaData.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ActionsMetaData/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ActionsMetaData' resource.", "operationId": "GetCapabilityActionsMetaDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ActionsMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ActionsMetaData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ActionsMetaData" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityActionsMetaDataByMoid": { "operationId": "GetCapabilityActionsMetaDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ActionsMetaData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterDeprecatedDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterDeprecatedDef' resource.", "operationId": "GetCapabilityAdapterDeprecatedDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.AdapterDeprecatedDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.AdapterDeprecatedDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterDeprecatedDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterDeprecatedDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterDeprecatedDef' resource.", "operationId": "GetCapabilityAdapterDeprecatedDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.AdapterDeprecatedDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.AdapterDeprecatedDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterDeprecatedDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityAdapterDeprecatedDefByMoid": { "operationId": "GetCapabilityAdapterDeprecatedDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterDeprecatedDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterFirmwareRequirements": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterFirmwareRequirement' resource.", "operationId": "GetCapabilityAdapterFirmwareRequirementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterFirmwareRequirement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.AdapterFirmwareRequirement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterFirmwareRequirement.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterFirmwareRequirements/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterFirmwareRequirement' resource.", "operationId": "GetCapabilityAdapterFirmwareRequirementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterFirmwareRequirement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.AdapterFirmwareRequirement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterFirmwareRequirement" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityAdapterFirmwareRequirementByMoid": { "operationId": "GetCapabilityAdapterFirmwareRequirementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterFirmwareRequirements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUnitDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUnitDescriptor' resource.", "operationId": "GetCapabilityAdapterUnitDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.capability.AdapterUnitDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.AdapterUnitDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUnitDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUnitDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUnitDescriptor' resource.", "operationId": "GetCapabilityAdapterUnitDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.capability.AdapterUnitDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.AdapterUnitDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUnitDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityAdapterUnitDescriptorByMoid": { "operationId": "GetCapabilityAdapterUnitDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUnitDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUpdateConstraintMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUpdateConstraintMeta' resource.", "operationId": "GetCapabilityAdapterUpdateConstraintMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.AdapterUpdateConstraintMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUpdateConstraintMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUpdateConstraintMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUpdateConstraintMeta' resource.", "operationId": "GetCapabilityAdapterUpdateConstraintMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.AdapterUpdateConstraintMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUpdateConstraintMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityAdapterUpdateConstraintMetaByMoid": { "operationId": "GetCapabilityAdapterUpdateConstraintMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUpdateConstraintMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUpgradeSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUpgradeSupportMeta' resource.", "operationId": "GetCapabilityAdapterUpgradeSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.AdapterUpgradeSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUpgradeSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/AdapterUpgradeSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.AdapterUpgradeSupportMeta' resource.", "operationId": "GetCapabilityAdapterUpgradeSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.AdapterUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.AdapterUpgradeSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.AdapterUpgradeSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityAdapterUpgradeSupportMetaByMoid": { "operationId": "GetCapabilityAdapterUpgradeSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/AdapterUpgradeSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/BiosTokens": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.BiosTokens' resource.", "operationId": "GetCapabilityBiosTokensList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.capability.BiosTokens", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.BiosTokens' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.BiosTokens.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/BiosTokens/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.BiosTokens' resource.", "operationId": "GetCapabilityBiosTokensByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.capability.BiosTokens", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.BiosTokens' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.BiosTokens" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityBiosTokensByMoid": { "operationId": "GetCapabilityBiosTokensByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/BiosTokens/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/Catalogs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.Catalog' resource.", "operationId": "GetCapabilityCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.Catalog", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.Catalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.Catalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/Catalogs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.Catalog' resource.", "operationId": "GetCapabilityCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.Catalog", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.Catalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.Catalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityCatalogByMoid": { "operationId": "GetCapabilityCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/Catalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisDescriptor' resource.", "operationId": "GetCapabilityChassisDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.ChassisDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ChassisDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisDescriptor' resource.", "operationId": "GetCapabilityChassisDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.ChassisDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ChassisDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityChassisDescriptorByMoid": { "operationId": "GetCapabilityChassisDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisManufacturingDef' resource.", "operationId": "GetCapabilityChassisManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ChassisManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ChassisManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisManufacturingDef' resource.", "operationId": "GetCapabilityChassisManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ChassisManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ChassisManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityChassisManufacturingDefByMoid": { "operationId": "GetCapabilityChassisManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisUpgradeSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisUpgradeSupportMeta' resource.", "operationId": "GetCapabilityChassisUpgradeSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ChassisUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ChassisUpgradeSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisUpgradeSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ChassisUpgradeSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ChassisUpgradeSupportMeta' resource.", "operationId": "GetCapabilityChassisUpgradeSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ChassisUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ChassisUpgradeSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ChassisUpgradeSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityChassisUpgradeSupportMetaByMoid": { "operationId": "GetCapabilityChassisUpgradeSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ChassisUpgradeSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/CimcFirmwareDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.CimcFirmwareDescriptor' resource.", "operationId": "GetCapabilityCimcFirmwareDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.CimcFirmwareDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.CimcFirmwareDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.CimcFirmwareDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/CimcFirmwareDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.CimcFirmwareDescriptor' resource.", "operationId": "GetCapabilityCimcFirmwareDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.CimcFirmwareDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.CimcFirmwareDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.CimcFirmwareDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityCimcFirmwareDescriptorByMoid": { "operationId": "GetCapabilityCimcFirmwareDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/CimcFirmwareDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/CpuEndpointDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.CpuEndpointDescriptor' resource.", "operationId": "GetCapabilityCpuEndpointDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.CpuEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.CpuEndpointDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.CpuEndpointDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/CpuEndpointDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.CpuEndpointDescriptor' resource.", "operationId": "GetCapabilityCpuEndpointDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.CpuEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.CpuEndpointDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.CpuEndpointDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityCpuEndpointDescriptorByMoid": { "operationId": "GetCapabilityCpuEndpointDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/CpuEndpointDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DimmsEndpointDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DimmsEndpointDescriptor' resource.", "operationId": "GetCapabilityDimmsEndpointDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DimmsEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.DimmsEndpointDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DimmsEndpointDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DimmsEndpointDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DimmsEndpointDescriptor' resource.", "operationId": "GetCapabilityDimmsEndpointDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DimmsEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.DimmsEndpointDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DimmsEndpointDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityDimmsEndpointDescriptorByMoid": { "operationId": "GetCapabilityDimmsEndpointDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/DimmsEndpointDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DomainPolicyRequirements": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DomainPolicyRequirement' resource.", "operationId": "GetCapabilityDomainPolicyRequirementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DomainPolicyRequirement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.DomainPolicyRequirement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DomainPolicyRequirement.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DomainPolicyRequirements/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DomainPolicyRequirement' resource.", "operationId": "GetCapabilityDomainPolicyRequirementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DomainPolicyRequirement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.DomainPolicyRequirement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DomainPolicyRequirement" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityDomainPolicyRequirementByMoid": { "operationId": "GetCapabilityDomainPolicyRequirementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/DomainPolicyRequirements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DrivesEndpointDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DrivesEndpointDescriptor' resource.", "operationId": "GetCapabilityDrivesEndpointDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DrivesEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.DrivesEndpointDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DrivesEndpointDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/DrivesEndpointDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.DrivesEndpointDescriptor' resource.", "operationId": "GetCapabilityDrivesEndpointDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.DrivesEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.DrivesEndpointDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.DrivesEndpointDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityDrivesEndpointDescriptorByMoid": { "operationId": "GetCapabilityDrivesEndpointDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/DrivesEndpointDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/EquipmentPhysicalDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.EquipmentPhysicalDef' resource.", "operationId": "GetCapabilityEquipmentPhysicalDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.EquipmentPhysicalDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.EquipmentPhysicalDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.EquipmentPhysicalDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/EquipmentPhysicalDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.EquipmentPhysicalDef' resource.", "operationId": "GetCapabilityEquipmentPhysicalDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.EquipmentPhysicalDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.EquipmentPhysicalDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.EquipmentPhysicalDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityEquipmentPhysicalDefByMoid": { "operationId": "GetCapabilityEquipmentPhysicalDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentPhysicalDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/EquipmentSlotArrays": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.EquipmentSlotArray' resource.", "operationId": "GetCapabilityEquipmentSlotArrayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.EquipmentSlotArray", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.EquipmentSlotArray' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.EquipmentSlotArray.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/EquipmentSlotArrays/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.EquipmentSlotArray' resource.", "operationId": "GetCapabilityEquipmentSlotArrayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.EquipmentSlotArray", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.EquipmentSlotArray' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.EquipmentSlotArray" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityEquipmentSlotArrayByMoid": { "operationId": "GetCapabilityEquipmentSlotArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/EquipmentSlotArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FanModuleDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FanModuleDescriptor' resource.", "operationId": "GetCapabilityFanModuleDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FanModuleDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FanModuleDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FanModuleDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FanModuleDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FanModuleDescriptor' resource.", "operationId": "GetCapabilityFanModuleDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FanModuleDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FanModuleDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FanModuleDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFanModuleDescriptorByMoid": { "operationId": "GetCapabilityFanModuleDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FanModuleManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FanModuleManufacturingDef' resource.", "operationId": "GetCapabilityFanModuleManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FanModuleManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FanModuleManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FanModuleManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FanModuleManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FanModuleManufacturingDef' resource.", "operationId": "GetCapabilityFanModuleManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FanModuleManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FanModuleManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FanModuleManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFanModuleManufacturingDefByMoid": { "operationId": "GetCapabilityFanModuleManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FanModuleManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexCapabilityDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexCapabilityDef' resource.", "operationId": "GetCapabilityFexCapabilityDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FexCapabilityDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FexCapabilityDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexCapabilityDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexCapabilityDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexCapabilityDef' resource.", "operationId": "GetCapabilityFexCapabilityDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.FexCapabilityDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FexCapabilityDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexCapabilityDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFexCapabilityDefByMoid": { "operationId": "GetCapabilityFexCapabilityDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FexCapabilityDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexDescriptor' resource.", "operationId": "GetCapabilityFexDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FexDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexDescriptor' resource.", "operationId": "GetCapabilityFexDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FexDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFexDescriptorByMoid": { "operationId": "GetCapabilityFexDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FexDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexManufacturingDef' resource.", "operationId": "GetCapabilityFexManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FexManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexManufacturingDef' resource.", "operationId": "GetCapabilityFexManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FexManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFexManufacturingDefByMoid": { "operationId": "GetCapabilityFexManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FexManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexSupportMeta' resource.", "operationId": "GetCapabilityFexSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.FexSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/FexSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.FexSupportMeta' resource.", "operationId": "GetCapabilityFexSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.FexSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.FexSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.FexSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityFexSupportMetaByMoid": { "operationId": "GetCapabilityFexSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/FexSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/GpuEndpointDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.GpuEndpointDescriptor' resource.", "operationId": "GetCapabilityGpuEndpointDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.GpuEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.GpuEndpointDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.GpuEndpointDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/GpuEndpointDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.GpuEndpointDescriptor' resource.", "operationId": "GetCapabilityGpuEndpointDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.GpuEndpointDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.GpuEndpointDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.GpuEndpointDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityGpuEndpointDescriptorByMoid": { "operationId": "GetCapabilityGpuEndpointDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/GpuEndpointDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/HsuIsoFileSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.HsuIsoFileSupportMeta' resource.", "operationId": "GetCapabilityHsuIsoFileSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.HsuIsoFileSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.HsuIsoFileSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.HsuIsoFileSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/HsuIsoFileSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.HsuIsoFileSupportMeta' resource.", "operationId": "GetCapabilityHsuIsoFileSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.HsuIsoFileSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.HsuIsoFileSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.HsuIsoFileSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityHsuIsoFileSupportMetaByMoid": { "operationId": "GetCapabilityHsuIsoFileSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/HsuIsoFileSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardCapabilityDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardCapabilityDef' resource.", "operationId": "GetCapabilityIoCardCapabilityDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardCapabilityDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.IoCardCapabilityDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardCapabilityDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardCapabilityDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardCapabilityDef' resource.", "operationId": "GetCapabilityIoCardCapabilityDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardCapabilityDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.IoCardCapabilityDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardCapabilityDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityIoCardCapabilityDefByMoid": { "operationId": "GetCapabilityIoCardCapabilityDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardCapabilityDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardDescriptor' resource.", "operationId": "GetCapabilityIoCardDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.IoCardDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardDescriptor' resource.", "operationId": "GetCapabilityIoCardDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.IoCardDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityIoCardDescriptorByMoid": { "operationId": "GetCapabilityIoCardDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardManufacturingDef' resource.", "operationId": "GetCapabilityIoCardManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.IoCardManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IoCardManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IoCardManufacturingDef' resource.", "operationId": "GetCapabilityIoCardManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.IoCardManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.IoCardManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IoCardManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityIoCardManufacturingDefByMoid": { "operationId": "GetCapabilityIoCardManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IoCardManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IomUpgradeSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IomUpgradeSupportMeta' resource.", "operationId": "GetCapabilityIomUpgradeSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.IomUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.IomUpgradeSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IomUpgradeSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/IomUpgradeSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.IomUpgradeSupportMeta' resource.", "operationId": "GetCapabilityIomUpgradeSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.IomUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.IomUpgradeSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.IomUpgradeSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityIomUpgradeSupportMetaByMoid": { "operationId": "GetCapabilityIomUpgradeSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/IomUpgradeSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/NetworkEquipmentPowerDefs": { "get": { "tags": [ "capability" ], "x-intersight-type": "SaaS", "summary": "Read a 'capability.NetworkEquipmentPowerDef' resource.", "operationId": "GetCapabilityNetworkEquipmentPowerDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.NetworkEquipmentPowerDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.NetworkEquipmentPowerDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.NetworkEquipmentPowerDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/NetworkEquipmentPowerDefs/{Moid}": { "get": { "tags": [ "capability" ], "x-intersight-type": "SaaS", "summary": "Read a 'capability.NetworkEquipmentPowerDef' resource.", "operationId": "GetCapabilityNetworkEquipmentPowerDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "READ.capability.NetworkEquipmentPowerDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.NetworkEquipmentPowerDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.NetworkEquipmentPowerDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityNetworkEquipmentPowerDefByMoid": { "operationId": "GetCapabilityNetworkEquipmentPowerDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/NetworkEquipmentPowerDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PolicyConstants": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PolicyConstants' resource.", "operationId": "GetCapabilityPolicyConstantsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Boot Order policies", "PRIVSET.View Server Profiles", "READ.capability.PolicyConstants", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.PolicyConstants' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PolicyConstants.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PolicyConstants/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PolicyConstants' resource.", "operationId": "GetCapabilityPolicyConstantsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Boot Order policies", "PRIVSET.View Server Profiles", "READ.capability.PolicyConstants", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.PolicyConstants' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PolicyConstants" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityPolicyConstantsByMoid": { "operationId": "GetCapabilityPolicyConstantsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PolicyConstants/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PortGroupAggregationDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PortGroupAggregationDef' resource.", "operationId": "GetCapabilityPortGroupAggregationDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.capability.PortGroupAggregationDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.PortGroupAggregationDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PortGroupAggregationDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PortGroupAggregationDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PortGroupAggregationDef' resource.", "operationId": "GetCapabilityPortGroupAggregationDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.capability.PortGroupAggregationDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.PortGroupAggregationDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PortGroupAggregationDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityPortGroupAggregationDefByMoid": { "operationId": "GetCapabilityPortGroupAggregationDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PortGroupAggregationDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ProcessorUnitUpdateConstraintMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ProcessorUnitUpdateConstraintMeta' resource.", "operationId": "GetCapabilityProcessorUnitUpdateConstraintMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ProcessorUnitUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ProcessorUnitUpdateConstraintMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ProcessorUnitUpdateConstraintMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ProcessorUnitUpdateConstraintMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ProcessorUnitUpdateConstraintMeta' resource.", "operationId": "GetCapabilityProcessorUnitUpdateConstraintMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ProcessorUnitUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ProcessorUnitUpdateConstraintMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ProcessorUnitUpdateConstraintMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityProcessorUnitUpdateConstraintMetaByMoid": { "operationId": "GetCapabilityProcessorUnitUpdateConstraintMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ProcessorUnitUpdateConstraintMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PsuDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PsuDescriptor' resource.", "operationId": "GetCapabilityPsuDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.PsuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.PsuDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PsuDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PsuDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PsuDescriptor' resource.", "operationId": "GetCapabilityPsuDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.PsuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.PsuDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PsuDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityPsuDescriptorByMoid": { "operationId": "GetCapabilityPsuDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PsuManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PsuManufacturingDef' resource.", "operationId": "GetCapabilityPsuManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.PsuManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.PsuManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PsuManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/PsuManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.PsuManufacturingDef' resource.", "operationId": "GetCapabilityPsuManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.PsuManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.PsuManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.PsuManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityPsuManufacturingDefByMoid": { "operationId": "GetCapabilityPsuManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/PsuManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerActionsMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerActionsMeta' resource.", "operationId": "GetCapabilityServerActionsMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerActionsMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerActionsMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerActionsMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerActionsMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerActionsMeta' resource.", "operationId": "GetCapabilityServerActionsMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerActionsMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerActionsMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerActionsMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerActionsMetaByMoid": { "operationId": "GetCapabilityServerActionsMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerActionsMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerDescriptor' resource.", "operationId": "GetCapabilityServerDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.ServerDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerDescriptor' resource.", "operationId": "GetCapabilityServerDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.ServerDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerDescriptorByMoid": { "operationId": "GetCapabilityServerDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerModelsCapabilityDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerModelsCapabilityDef' resource.", "operationId": "GetCapabilityServerModelsCapabilityDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerModelsCapabilityDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerModelsCapabilityDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerModelsCapabilityDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerModelsCapabilityDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerModelsCapabilityDef' resource.", "operationId": "GetCapabilityServerModelsCapabilityDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerModelsCapabilityDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerModelsCapabilityDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerModelsCapabilityDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerModelsCapabilityDefByMoid": { "operationId": "GetCapabilityServerModelsCapabilityDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerModelsCapabilityDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerPcieConnectivityCatalogs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerPcieConnectivityCatalog' resource.", "operationId": "GetCapabilityServerPcieConnectivityCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerPcieConnectivityCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerPcieConnectivityCatalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerPcieConnectivityCatalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerPcieConnectivityCatalogs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerPcieConnectivityCatalog' resource.", "operationId": "GetCapabilityServerPcieConnectivityCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerPcieConnectivityCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerPcieConnectivityCatalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerPcieConnectivityCatalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerPcieConnectivityCatalogByMoid": { "operationId": "GetCapabilityServerPcieConnectivityCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerPcieConnectivityCatalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerSchemaDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerSchemaDescriptor' resource.", "operationId": "GetCapabilityServerSchemaDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerSchemaDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerSchemaDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerSchemaDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerSchemaDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerSchemaDescriptor' resource.", "operationId": "GetCapabilityServerSchemaDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerSchemaDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerSchemaDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerSchemaDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerSchemaDescriptorByMoid": { "operationId": "GetCapabilityServerSchemaDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerSchemaDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerTopologyMaps": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerTopologyMap' resource.", "operationId": "GetCapabilityServerTopologyMapList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerTopologyMap", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerTopologyMap' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerTopologyMap.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerTopologyMaps/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerTopologyMap' resource.", "operationId": "GetCapabilityServerTopologyMapByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerTopologyMap", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerTopologyMap' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerTopologyMap" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerTopologyMapByMoid": { "operationId": "GetCapabilityServerTopologyMapByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerTopologyMaps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerUpgradeSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerUpgradeSupportMeta' resource.", "operationId": "GetCapabilityServerUpgradeSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.ServerUpgradeSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerUpgradeSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/ServerUpgradeSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.ServerUpgradeSupportMeta' resource.", "operationId": "GetCapabilityServerUpgradeSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.ServerUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.ServerUpgradeSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.ServerUpgradeSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityServerUpgradeSupportMetaByMoid": { "operationId": "GetCapabilityServerUpgradeSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/ServerUpgradeSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleCapabilityDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleCapabilityDef' resource.", "operationId": "GetCapabilitySiocModuleCapabilityDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleCapabilityDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SiocModuleCapabilityDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleCapabilityDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleCapabilityDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleCapabilityDef' resource.", "operationId": "GetCapabilitySiocModuleCapabilityDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleCapabilityDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SiocModuleCapabilityDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleCapabilityDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySiocModuleCapabilityDefByMoid": { "operationId": "GetCapabilitySiocModuleCapabilityDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleCapabilityDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleDescriptor' resource.", "operationId": "GetCapabilitySiocModuleDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SiocModuleDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleDescriptor' resource.", "operationId": "GetCapabilitySiocModuleDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SiocModuleDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySiocModuleDescriptorByMoid": { "operationId": "GetCapabilitySiocModuleDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleManufacturingDef' resource.", "operationId": "GetCapabilitySiocModuleManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SiocModuleManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SiocModuleManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SiocModuleManufacturingDef' resource.", "operationId": "GetCapabilitySiocModuleManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SiocModuleManufacturingDef", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SiocModuleManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SiocModuleManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySiocModuleManufacturingDefByMoid": { "operationId": "GetCapabilitySiocModuleManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SiocModuleManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StandardRedfishSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StandardRedfishSupportMeta' resource.", "operationId": "GetCapabilityStandardRedfishSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.StandardRedfishSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.StandardRedfishSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StandardRedfishSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StandardRedfishSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StandardRedfishSupportMeta' resource.", "operationId": "GetCapabilityStandardRedfishSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.StandardRedfishSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.StandardRedfishSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StandardRedfishSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityStandardRedfishSupportMetaByMoid": { "operationId": "GetCapabilityStandardRedfishSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/StandardRedfishSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StorageControllerUpdateConstraintMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StorageControllerUpdateConstraintMeta' resource.", "operationId": "GetCapabilityStorageControllerUpdateConstraintMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.StorageControllerUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.StorageControllerUpdateConstraintMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StorageControllerUpdateConstraintMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StorageControllerUpdateConstraintMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StorageControllerUpdateConstraintMeta' resource.", "operationId": "GetCapabilityStorageControllerUpdateConstraintMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.StorageControllerUpdateConstraintMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.StorageControllerUpdateConstraintMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StorageControllerUpdateConstraintMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityStorageControllerUpdateConstraintMetaByMoid": { "operationId": "GetCapabilityStorageControllerUpdateConstraintMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/StorageControllerUpdateConstraintMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StorageControllersMetaData": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StorageControllersMetaData' resource.", "operationId": "GetCapabilityStorageControllersMetaDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.capability.StorageControllersMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.StorageControllersMetaData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StorageControllersMetaData.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/StorageControllersMetaData/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.StorageControllersMetaData' resource.", "operationId": "GetCapabilityStorageControllersMetaDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.capability.StorageControllersMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.StorageControllersMetaData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.StorageControllersMetaData" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityStorageControllersMetaDataByMoid": { "operationId": "GetCapabilityStorageControllersMetaDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/StorageControllersMetaData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchCapabilities": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchCapability' resource.", "operationId": "GetCapabilitySwitchCapabilityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.SwitchCapability", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SwitchCapability' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchCapability.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchCapabilities/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchCapability' resource.", "operationId": "GetCapabilitySwitchCapabilityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.SwitchCapability", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SwitchCapability' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchCapability" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySwitchCapabilityByMoid": { "operationId": "GetCapabilitySwitchCapabilityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchCapabilities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchDescriptor' resource.", "operationId": "GetCapabilitySwitchDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.SwitchDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SwitchDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchDescriptor' resource.", "operationId": "GetCapabilitySwitchDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.UCS Domain Administrator", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.capability.SwitchDescriptor", "ROLE.Account Administrator", "ROLE.Read-Only", "ROLE.UCS Domain Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SwitchDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySwitchDescriptorByMoid": { "operationId": "GetCapabilitySwitchDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchEquipmentInfos": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchEquipmentInfo' resource.", "operationId": "GetCapabilitySwitchEquipmentInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SwitchEquipmentInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SwitchEquipmentInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchEquipmentInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchEquipmentInfos/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchEquipmentInfo' resource.", "operationId": "GetCapabilitySwitchEquipmentInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SwitchEquipmentInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SwitchEquipmentInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchEquipmentInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySwitchEquipmentInfoByMoid": { "operationId": "GetCapabilitySwitchEquipmentInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchEquipmentInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchManufacturingDefs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchManufacturingDef' resource.", "operationId": "GetCapabilitySwitchManufacturingDefList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.SwitchManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SwitchManufacturingDef' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchManufacturingDef.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchManufacturingDefs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchManufacturingDef' resource.", "operationId": "GetCapabilitySwitchManufacturingDefByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.SwitchManufacturingDef", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SwitchManufacturingDef' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchManufacturingDef" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySwitchManufacturingDefByMoid": { "operationId": "GetCapabilitySwitchManufacturingDefByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchManufacturingDefs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchUpgradeSupportMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchUpgradeSupportMeta' resource.", "operationId": "GetCapabilitySwitchUpgradeSupportMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SwitchUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.SwitchUpgradeSupportMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchUpgradeSupportMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/SwitchUpgradeSupportMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.SwitchUpgradeSupportMeta' resource.", "operationId": "GetCapabilitySwitchUpgradeSupportMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.SwitchUpgradeSupportMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.SwitchUpgradeSupportMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.SwitchUpgradeSupportMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilitySwitchUpgradeSupportMetaByMoid": { "operationId": "GetCapabilitySwitchUpgradeSupportMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/SwitchUpgradeSupportMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/TemplateCatalogs": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.TemplateCatalog' resource.", "operationId": "GetCapabilityTemplateCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.Read-only vHBA templates", "PRIVSET.Read-only vNIC templates", "PRIVSET.View Server Profiles", "READ.capability.TemplateCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.TemplateCatalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.TemplateCatalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/TemplateCatalogs/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.TemplateCatalog' resource.", "operationId": "GetCapabilityTemplateCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.Read-only vHBA templates", "PRIVSET.Read-only vNIC templates", "PRIVSET.View Server Profiles", "READ.capability.TemplateCatalog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.TemplateCatalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.TemplateCatalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityTemplateCatalogByMoid": { "operationId": "GetCapabilityTemplateCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/TemplateCatalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/TimeZoneMetaData": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.TimeZoneMetaData' resource.", "operationId": "GetCapabilityTimeZoneMetaDataList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.capability.TimeZoneMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.TimeZoneMetaData' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.TimeZoneMetaData.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/TimeZoneMetaData/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.TimeZoneMetaData' resource.", "operationId": "GetCapabilityTimeZoneMetaDataByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.capability.TimeZoneMetaData", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.TimeZoneMetaData' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.TimeZoneMetaData" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityTimeZoneMetaDataByMoid": { "operationId": "GetCapabilityTimeZoneMetaDataByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/TimeZoneMetaData/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/UpdateOrderMeta": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.UpdateOrderMeta' resource.", "operationId": "GetCapabilityUpdateOrderMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.UpdateOrderMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.UpdateOrderMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.UpdateOrderMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/UpdateOrderMeta/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.UpdateOrderMeta' resource.", "operationId": "GetCapabilityUpdateOrderMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.capability.UpdateOrderMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.UpdateOrderMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.UpdateOrderMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityUpdateOrderMetaByMoid": { "operationId": "GetCapabilityUpdateOrderMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/UpdateOrderMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/VicDescriptors": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.VicDescriptor' resource.", "operationId": "GetCapabilityVicDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.VicDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'capability.VicDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.VicDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/capability/VicDescriptors/{Moid}": { "get": { "tags": [ "capability" ], "summary": "Read a 'capability.VicDescriptor' resource.", "operationId": "GetCapabilityVicDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.capability.VicDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'capability.VicDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/capability.VicDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCapabilityVicDescriptorByMoid": { "operationId": "GetCapabilityVicDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/capability/VicDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/certificatemanagement/Policies": { "get": { "tags": [ "certificatemanagement" ], "summary": "Read a 'certificatemanagement.Policy' resource.", "operationId": "GetCertificatemanagementPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Certificate Management policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.certificatemanagement.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'certificatemanagement.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "certificatemanagement" ], "summary": "Create a 'certificatemanagement.Policy' resource.", "operationId": "CreateCertificatemanagementPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.certificatemanagement.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Certificate Management policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'certificatemanagement.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'certificatemanagement.Policy' resource was created as requested. The 'certificatemanagement.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } } }, "links": { "GetCertificatemanagementPolicyByMoid": { "operationId": "GetCertificatemanagementPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/certificatemanagement/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/certificatemanagement/Policies/{Moid}": { "get": { "tags": [ "certificatemanagement" ], "summary": "Read a 'certificatemanagement.Policy' resource.", "operationId": "GetCertificatemanagementPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Certificate Management policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.certificatemanagement.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'certificatemanagement.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCertificatemanagementPolicyByMoid": { "operationId": "GetCertificatemanagementPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/certificatemanagement/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "certificatemanagement" ], "summary": "Update a 'certificatemanagement.Policy' resource.", "operationId": "UpdateCertificatemanagementPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Certificate Management policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.certificatemanagement.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'certificatemanagement.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'certificatemanagement.Policy' resource was modified as requested. The 'certificatemanagement.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } } }, "links": { "GetCertificatemanagementPolicyByMoid": { "operationId": "GetCertificatemanagementPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/certificatemanagement/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "certificatemanagement" ], "summary": "Update a 'certificatemanagement.Policy' resource.", "operationId": "PatchCertificatemanagementPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Certificate Management policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.certificatemanagement.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'certificatemanagement.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'certificatemanagement.Policy' resource was patched as requested. The 'certificatemanagement.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.Policy" } } }, "links": { "GetCertificatemanagementPolicyByMoid": { "operationId": "GetCertificatemanagementPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/certificatemanagement/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "certificatemanagement" ], "summary": "Delete a 'certificatemanagement.Policy' resource.", "operationId": "DeleteCertificatemanagementPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.certificatemanagement.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Certificate Management policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/certificatemanagement/PolicyInventories": { "get": { "tags": [ "certificatemanagement" ], "summary": "Read a 'certificatemanagement.PolicyInventory' resource.", "operationId": "GetCertificatemanagementPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Certificate Management policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.certificatemanagement.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'certificatemanagement.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/certificatemanagement/PolicyInventories/{Moid}": { "get": { "tags": [ "certificatemanagement" ], "summary": "Read a 'certificatemanagement.PolicyInventory' resource.", "operationId": "GetCertificatemanagementPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Certificate Management policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.certificatemanagement.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'certificatemanagement.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/certificatemanagement.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetCertificatemanagementPolicyInventoryByMoid": { "operationId": "GetCertificatemanagementPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/certificatemanagement/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigChangeDetails": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigChangeDetail' resource.", "operationId": "GetChassisConfigChangeDetailList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigChangeDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.ConfigChangeDetail' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigChangeDetail.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigChangeDetails/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigChangeDetail' resource.", "operationId": "GetChassisConfigChangeDetailByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigChangeDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.ConfigChangeDetail' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigChangeDetail" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisConfigChangeDetailByMoid": { "operationId": "GetChassisConfigChangeDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ConfigChangeDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigImports": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigImport' resource.", "operationId": "GetChassisConfigImportList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigImport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.ConfigImport' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigImport.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "chassis" ], "summary": "Create a 'chassis.ConfigImport' resource.", "operationId": "CreateChassisConfigImport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.chassis.ConfigImport", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'chassis.ConfigImport' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigImport" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.ConfigImport' resource was created as requested. The 'chassis.ConfigImport' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigImport" } } }, "links": { "GetChassisConfigImportByMoid": { "operationId": "GetChassisConfigImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ConfigImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigImports/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigImport' resource.", "operationId": "GetChassisConfigImportByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigImport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.ConfigImport' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigImport" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisConfigImportByMoid": { "operationId": "GetChassisConfigImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ConfigImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigResults": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigResult' resource.", "operationId": "GetChassisConfigResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.ConfigResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigResult.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigResults/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigResult' resource.", "operationId": "GetChassisConfigResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.ConfigResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigResult" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisConfigResultByMoid": { "operationId": "GetChassisConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigResultEntries": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigResultEntry' resource.", "operationId": "GetChassisConfigResultEntryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigResultEntry", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.ConfigResultEntry' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigResultEntry.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ConfigResultEntries/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ConfigResultEntry' resource.", "operationId": "GetChassisConfigResultEntryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.ConfigResultEntry", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.ConfigResultEntry' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ConfigResultEntry" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisConfigResultEntryByMoid": { "operationId": "GetChassisConfigResultEntryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ConfigResultEntries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/IomProfiles": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.IomProfile' resource.", "operationId": "GetChassisIomProfileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.IomProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.IomProfile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.IomProfile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/IomProfiles/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.IomProfile' resource.", "operationId": "GetChassisIomProfileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.IomProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.IomProfile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.IomProfile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisIomProfileByMoid": { "operationId": "GetChassisIomProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/IomProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/Profiles": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.Profile' resource.", "operationId": "GetChassisProfileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.Profile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.Profile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "chassis" ], "summary": "Create a 'chassis.Profile' resource.", "operationId": "CreateChassisProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.chassis.Profile", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'chassis.Profile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.Profile' resource was created as requested. The 'chassis.Profile' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } } }, "links": { "GetChassisProfileByMoid": { "operationId": "GetChassisProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/Profiles/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.Profile' resource.", "operationId": "GetChassisProfileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profiles", "PRIVSET.View Server Profiles", "READ.chassis.Profile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.Profile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisProfileByMoid": { "operationId": "GetChassisProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "chassis" ], "summary": "Update a 'chassis.Profile' resource.", "operationId": "UpdateChassisProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.chassis.Profile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'chassis.Profile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.Profile' resource was modified as requested. The 'chassis.Profile' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } } }, "links": { "GetChassisProfileByMoid": { "operationId": "GetChassisProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "chassis" ], "summary": "Update a 'chassis.Profile' resource.", "operationId": "PatchChassisProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.chassis.Profile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'chassis.Profile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.Profile' resource was patched as requested. The 'chassis.Profile' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.Profile" } } }, "links": { "GetChassisProfileByMoid": { "operationId": "GetChassisProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "chassis" ], "summary": "Delete a 'chassis.Profile' resource.", "operationId": "DeleteChassisProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.chassis.Profile", "PRIVSET.Account Administrator", "PRIVSET.Delete chassis profiles", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ProfileTemplates": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ProfileTemplate' resource.", "operationId": "GetChassisProfileTemplateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.View Server Profiles", "READ.chassis.ProfileTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'chassis.ProfileTemplate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "chassis" ], "summary": "Create a 'chassis.ProfileTemplate' resource.", "operationId": "CreateChassisProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.chassis.ProfileTemplate", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'chassis.ProfileTemplate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.ProfileTemplate' resource was created as requested. The 'chassis.ProfileTemplate' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } } }, "links": { "GetChassisProfileTemplateByMoid": { "operationId": "GetChassisProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/chassis/ProfileTemplates/{Moid}": { "get": { "tags": [ "chassis" ], "summary": "Read a 'chassis.ProfileTemplate' resource.", "operationId": "GetChassisProfileTemplateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS chassis profile templates", "PRIVSET.View Server Profiles", "READ.chassis.ProfileTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'chassis.ProfileTemplate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetChassisProfileTemplateByMoid": { "operationId": "GetChassisProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "chassis" ], "summary": "Update a 'chassis.ProfileTemplate' resource.", "operationId": "UpdateChassisProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.chassis.ProfileTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'chassis.ProfileTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.ProfileTemplate' resource was modified as requested. The 'chassis.ProfileTemplate' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } } }, "links": { "GetChassisProfileTemplateByMoid": { "operationId": "GetChassisProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "chassis" ], "summary": "Update a 'chassis.ProfileTemplate' resource.", "operationId": "PatchChassisProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.chassis.ProfileTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'chassis.ProfileTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'chassis.ProfileTemplate' resource was patched as requested. The 'chassis.ProfileTemplate' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/chassis.ProfileTemplate" } } }, "links": { "GetChassisProfileTemplateByMoid": { "operationId": "GetChassisProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/chassis/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "chassis" ], "summary": "Delete a 'chassis.ProfileTemplate' resource.", "operationId": "DeleteChassisProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.chassis.ProfileTemplate", "PRIVSET.Account Administrator", "PRIVSET.Delete chassis profile templates", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Blades": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Blade' resource.", "operationId": "GetComputeBladeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.Blade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.Blade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Blades/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Blade' resource.", "operationId": "GetComputeBladeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.Blade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.Blade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeBladeByMoid": { "operationId": "GetComputeBladeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.Blade' resource.", "operationId": "UpdateComputeBlade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Blade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Blade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Blade' resource was modified as requested. The 'compute.Blade' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade" } } }, "links": { "GetComputeBladeByMoid": { "operationId": "GetComputeBladeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.Blade' resource.", "operationId": "PatchComputeBlade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Blade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Blade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Blade' resource was patched as requested. The 'compute.Blade' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Blade" } } }, "links": { "GetComputeBladeByMoid": { "operationId": "GetComputeBladeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Blades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/BladeIdentities": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.BladeIdentity' resource.", "operationId": "GetComputeBladeIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.compute.BladeIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.BladeIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/BladeIdentities/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.BladeIdentity' resource.", "operationId": "GetComputeBladeIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.compute.BladeIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.BladeIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeBladeIdentityByMoid": { "operationId": "GetComputeBladeIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.BladeIdentity' resource.", "operationId": "UpdateComputeBladeIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.compute.BladeIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.BladeIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.BladeIdentity' resource was modified as requested. The 'compute.BladeIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity" } } }, "links": { "GetComputeBladeIdentityByMoid": { "operationId": "GetComputeBladeIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.BladeIdentity' resource.", "operationId": "PatchComputeBladeIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.compute.BladeIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.BladeIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.BladeIdentity' resource was patched as requested. The 'compute.BladeIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.BladeIdentity" } } }, "links": { "GetComputeBladeIdentityByMoid": { "operationId": "GetComputeBladeIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/BladeIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Boards": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Board' resource.", "operationId": "GetComputeBoardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.Board", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.Board' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Boards/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Board' resource.", "operationId": "GetComputeBoardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.Board", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.Board' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeBoardByMoid": { "operationId": "GetComputeBoardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.Board' resource.", "operationId": "UpdateComputeBoard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Board" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Board' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Board' resource was modified as requested. The 'compute.Board' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board" } } }, "links": { "GetComputeBoardByMoid": { "operationId": "GetComputeBoardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.Board' resource.", "operationId": "PatchComputeBoard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Board" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Board' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Board' resource was patched as requested. The 'compute.Board' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Board" } } }, "links": { "GetComputeBoardByMoid": { "operationId": "GetComputeBoardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Boards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/DownloadStatuses": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.DownloadStatus' resource.", "operationId": "GetComputeDownloadStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.DownloadStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.DownloadStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.DownloadStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/DownloadStatuses/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.DownloadStatus' resource.", "operationId": "GetComputeDownloadStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.DownloadStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.DownloadStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.DownloadStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeDownloadStatusByMoid": { "operationId": "GetComputeDownloadStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/DownloadStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/HostUtilityOperations": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.HostUtilityOperation' resource.", "operationId": "GetComputeHostUtilityOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.HostUtilityOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.HostUtilityOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.HostUtilityOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Create a 'compute.HostUtilityOperation' resource.", "operationId": "CreateComputeHostUtilityOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.compute.HostUtilityOperation", "PRIVSET.Account Administrator", "PRIVSET.Decommission servers", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'compute.HostUtilityOperation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.HostUtilityOperation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.HostUtilityOperation' resource was created as requested. The 'compute.HostUtilityOperation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.HostUtilityOperation" } } }, "links": { "GetComputeHostUtilityOperationByMoid": { "operationId": "GetComputeHostUtilityOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/HostUtilityOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/HostUtilityOperations/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.HostUtilityOperation' resource.", "operationId": "GetComputeHostUtilityOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.HostUtilityOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.HostUtilityOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.HostUtilityOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeHostUtilityOperationByMoid": { "operationId": "GetComputeHostUtilityOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/HostUtilityOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Mappings": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Mapping' resource.", "operationId": "GetComputeMappingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.compute.Mapping" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.Mapping' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Mappings/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Mapping' resource.", "operationId": "GetComputeMappingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.compute.Mapping" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.Mapping' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeMappingByMoid": { "operationId": "GetComputeMappingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Mappings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.Mapping' resource.", "operationId": "UpdateComputeMapping", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.compute.Mapping" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Mapping' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Mapping' resource was modified as requested. The 'compute.Mapping' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping" } } }, "links": { "GetComputeMappingByMoid": { "operationId": "GetComputeMappingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Mappings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.Mapping' resource.", "operationId": "PatchComputeMapping", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.compute.Mapping" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Mapping' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Mapping' resource was patched as requested. The 'compute.Mapping' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Mapping" } } }, "links": { "GetComputeMappingByMoid": { "operationId": "GetComputeMappingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Mappings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PcieConnectivityPolicies": { "post": { "tags": [ "compute" ], "summary": "Create a 'compute.PcieConnectivityPolicy' resource.", "operationId": "CreateComputePcieConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.compute.PcieConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'compute.PcieConnectivityPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.PcieConnectivityPolicy' resource was created as requested. The 'compute.PcieConnectivityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } } }, "links": { "GetComputePcieConnectivityPolicyByMoid": { "operationId": "GetComputePcieConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PcieConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PcieConnectivityPolicy' resource.", "operationId": "GetComputePcieConnectivityPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "READ.compute.PcieConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.PcieConnectivityPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PcieConnectivityPolicies/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PcieConnectivityPolicy' resource.", "operationId": "GetComputePcieConnectivityPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "READ.compute.PcieConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.PcieConnectivityPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputePcieConnectivityPolicyByMoid": { "operationId": "GetComputePcieConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PcieConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.PcieConnectivityPolicy' resource.", "operationId": "UpdateComputePcieConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.PcieConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.PcieConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.PcieConnectivityPolicy' resource was modified as requested. The 'compute.PcieConnectivityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } } }, "links": { "GetComputePcieConnectivityPolicyByMoid": { "operationId": "GetComputePcieConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PcieConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.PcieConnectivityPolicy' resource.", "operationId": "PatchComputePcieConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.PcieConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.PcieConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.PcieConnectivityPolicy' resource was patched as requested. The 'compute.PcieConnectivityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" } } }, "links": { "GetComputePcieConnectivityPolicyByMoid": { "operationId": "GetComputePcieConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PcieConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "compute" ], "summary": "Delete a 'compute.PcieConnectivityPolicy' resource.", "operationId": "DeleteComputePcieConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.compute.PcieConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PcieConnectivityPolicyInventories": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PcieConnectivityPolicyInventory' resource.", "operationId": "GetComputePcieConnectivityPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "READ.compute.PcieConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.PcieConnectivityPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PcieConnectivityPolicyInventories/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PcieConnectivityPolicyInventory' resource.", "operationId": "GetComputePcieConnectivityPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "READ.compute.PcieConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.PcieConnectivityPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputePcieConnectivityPolicyInventoryByMoid": { "operationId": "GetComputePcieConnectivityPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PcieConnectivityPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Personalities": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Personality' resource.", "operationId": "GetComputePersonalityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.compute.Personality", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.Personality' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Personalities/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Personality' resource.", "operationId": "GetComputePersonalityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.compute.Personality", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.Personality' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputePersonalityByMoid": { "operationId": "GetComputePersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Personalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.Personality' resource.", "operationId": "UpdateComputePersonality", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Personality" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Personality' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Personality' resource was modified as requested. The 'compute.Personality' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality" } } }, "links": { "GetComputePersonalityByMoid": { "operationId": "GetComputePersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Personalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.Personality' resource.", "operationId": "PatchComputePersonality", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.Personality" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.Personality' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.Personality' resource was patched as requested. The 'compute.Personality' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Personality" } } }, "links": { "GetComputePersonalityByMoid": { "operationId": "GetComputePersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Personalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PhysicalSummaries": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PhysicalSummary' resource.", "operationId": "GetComputePhysicalSummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.PhysicalSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.PhysicalSummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PhysicalSummary.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/PhysicalSummaries/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.PhysicalSummary' resource.", "operationId": "GetComputePhysicalSummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure metrics settings", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only HyperFlex clusters", "PRIVSET.Read-only resource pools", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.PhysicalSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.PhysicalSummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.PhysicalSummary" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputePhysicalSummaryByMoid": { "operationId": "GetComputePhysicalSummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/PhysicalSummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/RackUnits": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.RackUnit' resource.", "operationId": "GetComputeRackUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.RackUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.RackUnit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/RackUnits/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.RackUnit' resource.", "operationId": "GetComputeRackUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.RackUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.RackUnit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeRackUnitByMoid": { "operationId": "GetComputeRackUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.RackUnit' resource.", "operationId": "UpdateComputeRackUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.RackUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.RackUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnit' resource was modified as requested. The 'compute.RackUnit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit" } } }, "links": { "GetComputeRackUnitByMoid": { "operationId": "GetComputeRackUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.RackUnit' resource.", "operationId": "PatchComputeRackUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.RackUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.RackUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnit' resource was patched as requested. The 'compute.RackUnit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnit" } } }, "links": { "GetComputeRackUnitByMoid": { "operationId": "GetComputeRackUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "compute" ], "summary": "Delete a 'compute.RackUnit' resource.", "operationId": "DeleteComputeRackUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.compute.RackUnit", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/RackUnitIdentities": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.RackUnitIdentity' resource.", "operationId": "GetComputeRackUnitIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.RackUnitIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.RackUnitIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/RackUnitIdentities/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.RackUnitIdentity' resource.", "operationId": "GetComputeRackUnitIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.RackUnitIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.RackUnitIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeRackUnitIdentityByMoid": { "operationId": "GetComputeRackUnitIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.RackUnitIdentity' resource.", "operationId": "UpdateComputeRackUnitIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.RackUnitIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.RackUnitIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnitIdentity' resource was modified as requested. The 'compute.RackUnitIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity" } } }, "links": { "GetComputeRackUnitIdentityByMoid": { "operationId": "GetComputeRackUnitIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.RackUnitIdentity' resource.", "operationId": "PatchComputeRackUnitIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.RackUnitIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.RackUnitIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.RackUnitIdentity' resource was patched as requested. The 'compute.RackUnitIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.RackUnitIdentity" } } }, "links": { "GetComputeRackUnitIdentityByMoid": { "operationId": "GetComputeRackUnitIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/RackUnitIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "compute" ], "summary": "Delete a 'compute.RackUnitIdentity' resource.", "operationId": "DeleteComputeRackUnitIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.compute.RackUnitIdentity", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ScrubPolicies": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ScrubPolicy' resource.", "operationId": "GetComputeScrubPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Scrub policies", "PRIVSET.View Server Profiles", "READ.compute.ScrubPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.ScrubPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Create a 'compute.ScrubPolicy' resource.", "operationId": "CreateComputeScrubPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.compute.ScrubPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Scrub policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'compute.ScrubPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ScrubPolicy' resource was created as requested. The 'compute.ScrubPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } } }, "links": { "GetComputeScrubPolicyByMoid": { "operationId": "GetComputeScrubPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ScrubPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ScrubPolicies/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ScrubPolicy' resource.", "operationId": "GetComputeScrubPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Scrub policies", "PRIVSET.View Server Profiles", "READ.compute.ScrubPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.ScrubPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeScrubPolicyByMoid": { "operationId": "GetComputeScrubPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ScrubPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.ScrubPolicy' resource.", "operationId": "UpdateComputeScrubPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Scrub policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.ScrubPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ScrubPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ScrubPolicy' resource was modified as requested. The 'compute.ScrubPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } } }, "links": { "GetComputeScrubPolicyByMoid": { "operationId": "GetComputeScrubPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ScrubPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.ScrubPolicy' resource.", "operationId": "PatchComputeScrubPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Scrub policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.ScrubPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ScrubPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ScrubPolicy' resource was patched as requested. The 'compute.ScrubPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ScrubPolicy" } } }, "links": { "GetComputeScrubPolicyByMoid": { "operationId": "GetComputeScrubPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ScrubPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "compute" ], "summary": "Delete a 'compute.ScrubPolicy' resource.", "operationId": "DeleteComputeScrubPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.compute.ScrubPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Scrub policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerIdPools": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerIdPool' resource.", "operationId": "GetComputeServerIdPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.ServerIdPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.ServerIdPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerIdPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerIdPools/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerIdPool' resource.", "operationId": "GetComputeServerIdPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.ServerIdPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.ServerIdPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerIdPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeServerIdPoolByMoid": { "operationId": "GetComputeServerIdPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerIdPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerPowerParameters": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerPowerParameters' resource.", "operationId": "GetComputeServerPowerParametersList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.ServerPowerParameters", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.ServerPowerParameters' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerParameters.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerPowerParameters/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerPowerParameters' resource.", "operationId": "GetComputeServerPowerParametersByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.compute.ServerPowerParameters", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.ServerPowerParameters' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerParameters" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeServerPowerParametersByMoid": { "operationId": "GetComputeServerPowerParametersByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerPowerParameters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerPowerPolicies": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerPowerPolicy' resource.", "operationId": "GetComputeServerPowerPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.compute.ServerPowerPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.ServerPowerPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerPowerPolicies/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerPowerPolicy' resource.", "operationId": "GetComputeServerPowerPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.compute.ServerPowerPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.ServerPowerPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeServerPowerPolicyByMoid": { "operationId": "GetComputeServerPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerPowerPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.ServerPowerPolicy' resource.", "operationId": "UpdateComputeServerPowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.ServerPowerPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ServerPowerPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerPowerPolicy' resource was modified as requested. The 'compute.ServerPowerPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" } } }, "links": { "GetComputeServerPowerPolicyByMoid": { "operationId": "GetComputeServerPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerPowerPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.ServerPowerPolicy' resource.", "operationId": "PatchComputeServerPowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.compute.ServerPowerPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ServerPowerPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerPowerPolicy' resource was patched as requested. The 'compute.ServerPowerPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" } } }, "links": { "GetComputeServerPowerPolicyByMoid": { "operationId": "GetComputeServerPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerPowerPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "compute" ], "summary": "Delete a 'compute.ServerPowerPolicy' resource.", "operationId": "DeleteComputeServerPowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.compute.ServerPowerPolicy", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerSettings": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerSetting' resource.", "operationId": "GetComputeServerSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.ServerSetting", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.ServerSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/ServerSettings/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.ServerSetting' resource.", "operationId": "GetComputeServerSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.ServerSetting", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.ServerSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeServerSettingByMoid": { "operationId": "GetComputeServerSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "compute" ], "summary": "Update a 'compute.ServerSetting' resource.", "operationId": "UpdateComputeServerSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.ServerSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ServerSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerSetting' resource was modified as requested. The 'compute.ServerSetting' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting" } } }, "links": { "GetComputeServerSettingByMoid": { "operationId": "GetComputeServerSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "compute" ], "summary": "Update a 'compute.ServerSetting' resource.", "operationId": "PatchComputeServerSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.compute.ServerSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'compute.ServerSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'compute.ServerSetting' resource was patched as requested. The 'compute.ServerSetting' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.ServerSetting" } } }, "links": { "GetComputeServerSettingByMoid": { "operationId": "GetComputeServerSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/ServerSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Vmedia": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Vmedia' resource.", "operationId": "GetComputeVmediaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.Vmedia", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'compute.Vmedia' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Vmedia.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/compute/Vmedia/{Moid}": { "get": { "tags": [ "compute" ], "summary": "Read a 'compute.Vmedia' resource.", "operationId": "GetComputeVmediaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.compute.Vmedia", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'compute.Vmedia' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compute.Vmedia" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetComputeVmediaByMoid": { "operationId": "GetComputeVmediaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/compute/Vmedia/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/deviceconnector/Policies": { "post": { "tags": [ "deviceconnector" ], "summary": "Create a 'deviceconnector.Policy' resource.", "operationId": "CreateDeviceconnectorPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.deviceconnector.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Device Connector policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'deviceconnector.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'deviceconnector.Policy' resource was created as requested. The 'deviceconnector.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } } }, "links": { "GetDeviceconnectorPolicyByMoid": { "operationId": "GetDeviceconnectorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "deviceconnector" ], "summary": "Read a 'deviceconnector.Policy' resource.", "operationId": "GetDeviceconnectorPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Device Connector Policies", "PRIVSET.View Server Profiles", "READ.deviceconnector.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'deviceconnector.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/deviceconnector/Policies/{Moid}": { "get": { "tags": [ "deviceconnector" ], "summary": "Read a 'deviceconnector.Policy' resource.", "operationId": "GetDeviceconnectorPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Device Connector Policies", "PRIVSET.View Server Profiles", "READ.deviceconnector.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'deviceconnector.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetDeviceconnectorPolicyByMoid": { "operationId": "GetDeviceconnectorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "deviceconnector" ], "summary": "Update a 'deviceconnector.Policy' resource.", "operationId": "UpdateDeviceconnectorPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Device Connector policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.deviceconnector.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'deviceconnector.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'deviceconnector.Policy' resource was modified as requested. The 'deviceconnector.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } } }, "links": { "GetDeviceconnectorPolicyByMoid": { "operationId": "GetDeviceconnectorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "deviceconnector" ], "summary": "Update a 'deviceconnector.Policy' resource.", "operationId": "PatchDeviceconnectorPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Device Connector policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.deviceconnector.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'deviceconnector.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'deviceconnector.Policy' resource was patched as requested. The 'deviceconnector.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deviceconnector.Policy" } } }, "links": { "GetDeviceconnectorPolicyByMoid": { "operationId": "GetDeviceconnectorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/deviceconnector/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "deviceconnector" ], "summary": "Delete a 'deviceconnector.Policy' resource.", "operationId": "DeleteDeviceconnectorPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.deviceconnector.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Device Connector policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Chasses": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Chassis' resource.", "operationId": "GetEquipmentChassisList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.equipment.Chassis", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Chassis' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Chasses/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Chassis' resource.", "operationId": "GetEquipmentChassisByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.equipment.Chassis", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Chassis' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentChassisByMoid": { "operationId": "GetEquipmentChassisByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Chassis' resource.", "operationId": "UpdateEquipmentChassis", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.equipment.Chassis" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Chassis' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Chassis' resource was modified as requested. The 'equipment.Chassis' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis" } } }, "links": { "GetEquipmentChassisByMoid": { "operationId": "GetEquipmentChassisByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Chassis' resource.", "operationId": "PatchEquipmentChassis", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.equipment.Chassis" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Chassis' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Chassis' resource was patched as requested. The 'equipment.Chassis' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Chassis" } } }, "links": { "GetEquipmentChassisByMoid": { "operationId": "GetEquipmentChassisByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Chasses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisControllers": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisController' resource.", "operationId": "GetEquipmentChassisControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "READ.equipment.ChassisController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ChassisController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisControllers/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisController' resource.", "operationId": "GetEquipmentChassisControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "READ.equipment.ChassisController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ChassisController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentChassisControllerByMoid": { "operationId": "GetEquipmentChassisControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisController' resource.", "operationId": "UpdateEquipmentChassisController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ChassisController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisController' resource was modified as requested. The 'equipment.ChassisController' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController" } } }, "links": { "GetEquipmentChassisControllerByMoid": { "operationId": "GetEquipmentChassisControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisController' resource.", "operationId": "PatchEquipmentChassisController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ChassisController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisController' resource was patched as requested. The 'equipment.ChassisController' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisController" } } }, "links": { "GetEquipmentChassisControllerByMoid": { "operationId": "GetEquipmentChassisControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisIdPools": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisIdPool' resource.", "operationId": "GetEquipmentChassisIdPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "READ.equipment.ChassisIdPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ChassisIdPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisIdPools/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisIdPool' resource.", "operationId": "GetEquipmentChassisIdPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "READ.equipment.ChassisIdPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ChassisIdPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentChassisIdPoolByMoid": { "operationId": "GetEquipmentChassisIdPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisIdentities": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisIdentity' resource.", "operationId": "GetEquipmentChassisIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.equipment.ChassisIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ChassisIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisIdentities/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisIdentity' resource.", "operationId": "GetEquipmentChassisIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Servers", "PRIVSET.View Unified Edge", "READ.equipment.ChassisIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ChassisIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentChassisIdentityByMoid": { "operationId": "GetEquipmentChassisIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisIdentity' resource.", "operationId": "UpdateEquipmentChassisIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.equipment.ChassisIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisIdentity' resource was modified as requested. The 'equipment.ChassisIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity" } } }, "links": { "GetEquipmentChassisIdentityByMoid": { "operationId": "GetEquipmentChassisIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisIdentity' resource.", "operationId": "PatchEquipmentChassisIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator", "UPDATE.equipment.ChassisIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisIdentity' resource was patched as requested. The 'equipment.ChassisIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisIdentity" } } }, "links": { "GetEquipmentChassisIdentityByMoid": { "operationId": "GetEquipmentChassisIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisOperations": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisOperation' resource.", "operationId": "GetEquipmentChassisOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Fabric Interconnects", "READ.equipment.ChassisOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ChassisOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ChassisOperations/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ChassisOperation' resource.", "operationId": "GetEquipmentChassisOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.View Fabric Interconnects", "READ.equipment.ChassisOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ChassisOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentChassisOperationByMoid": { "operationId": "GetEquipmentChassisOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisOperation' resource.", "operationId": "UpdateEquipmentChassisOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ChassisOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisOperation' resource was modified as requested. The 'equipment.ChassisOperation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation" } } }, "links": { "GetEquipmentChassisOperationByMoid": { "operationId": "GetEquipmentChassisOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ChassisOperation' resource.", "operationId": "PatchEquipmentChassisOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ChassisOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ChassisOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ChassisOperation' resource was patched as requested. The 'equipment.ChassisOperation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ChassisOperation" } } }, "links": { "GetEquipmentChassisOperationByMoid": { "operationId": "GetEquipmentChassisOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ChassisOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/DeviceSummaries": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.DeviceSummary' resource.", "operationId": "GetEquipmentDeviceSummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.equipment.DeviceSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.DeviceSummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.DeviceSummary.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/DeviceSummaries/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.DeviceSummary' resource.", "operationId": "GetEquipmentDeviceSummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Server Profiles", "PRIVSET.View Servers", "READ.equipment.DeviceSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.DeviceSummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.DeviceSummary" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentDeviceSummaryByMoid": { "operationId": "GetEquipmentDeviceSummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/DeviceSummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/EnclosureElements": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.EnclosureElement' resource.", "operationId": "GetEquipmentEnclosureElementList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.EnclosureElement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.EnclosureElement' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/EnclosureElements/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.EnclosureElement' resource.", "operationId": "GetEquipmentEnclosureElementByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.EnclosureElement", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.EnclosureElement' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentEnclosureElementByMoid": { "operationId": "GetEquipmentEnclosureElementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/EnclosureElements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.EnclosureElement' resource.", "operationId": "UpdateEquipmentEnclosureElement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.EnclosureElement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.EnclosureElement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.EnclosureElement' resource was modified as requested. The 'equipment.EnclosureElement' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement" } } }, "links": { "GetEquipmentEnclosureElementByMoid": { "operationId": "GetEquipmentEnclosureElementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/EnclosureElements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.EnclosureElement' resource.", "operationId": "PatchEquipmentEnclosureElement", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.EnclosureElement" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.EnclosureElement' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.EnclosureElement' resource was patched as requested. The 'equipment.EnclosureElement' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EnclosureElement" } } }, "links": { "GetEquipmentEnclosureElementByMoid": { "operationId": "GetEquipmentEnclosureElementByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/EnclosureElements/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/EndPointLogs": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.EndPointLog' resource.", "operationId": "GetEquipmentEndPointLogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.EndPointLog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.EndPointLog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EndPointLog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/EndPointLogs/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.EndPointLog' resource.", "operationId": "GetEquipmentEndPointLogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.EndPointLog", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.EndPointLog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.EndPointLog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentEndPointLogByMoid": { "operationId": "GetEquipmentEndPointLogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/EndPointLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModules": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModule' resource.", "operationId": "GetEquipmentExpanderModuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.ExpanderModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ExpanderModule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModules/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModule' resource.", "operationId": "GetEquipmentExpanderModuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.ExpanderModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ExpanderModule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentExpanderModuleByMoid": { "operationId": "GetEquipmentExpanderModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModule' resource.", "operationId": "UpdateEquipmentExpanderModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModule' resource was modified as requested. The 'equipment.ExpanderModule' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule" } } }, "links": { "GetEquipmentExpanderModuleByMoid": { "operationId": "GetEquipmentExpanderModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModule' resource.", "operationId": "PatchEquipmentExpanderModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModule' resource was patched as requested. The 'equipment.ExpanderModule' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModule" } } }, "links": { "GetEquipmentExpanderModuleByMoid": { "operationId": "GetEquipmentExpanderModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModuleIdentities": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModuleIdentity' resource.", "operationId": "GetEquipmentExpanderModuleIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.ExpanderModuleIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ExpanderModuleIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModuleIdentities/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModuleIdentity' resource.", "operationId": "GetEquipmentExpanderModuleIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.ExpanderModuleIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ExpanderModuleIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentExpanderModuleIdentityByMoid": { "operationId": "GetEquipmentExpanderModuleIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModuleIdentity' resource.", "operationId": "UpdateEquipmentExpanderModuleIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModuleIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModuleIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModuleIdentity' resource was modified as requested. The 'equipment.ExpanderModuleIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" } } }, "links": { "GetEquipmentExpanderModuleIdentityByMoid": { "operationId": "GetEquipmentExpanderModuleIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModuleIdentity' resource.", "operationId": "PatchEquipmentExpanderModuleIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModuleIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModuleIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModuleIdentity' resource was patched as requested. The 'equipment.ExpanderModuleIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" } } }, "links": { "GetEquipmentExpanderModuleIdentityByMoid": { "operationId": "GetEquipmentExpanderModuleIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModuleOperations": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModuleOperation' resource.", "operationId": "GetEquipmentExpanderModuleOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.ExpanderModuleOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.ExpanderModuleOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/ExpanderModuleOperations/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.ExpanderModuleOperation' resource.", "operationId": "GetEquipmentExpanderModuleOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.ExpanderModuleOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.ExpanderModuleOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentExpanderModuleOperationByMoid": { "operationId": "GetEquipmentExpanderModuleOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModuleOperation' resource.", "operationId": "UpdateEquipmentExpanderModuleOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModuleOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModuleOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModuleOperation' resource was modified as requested. The 'equipment.ExpanderModuleOperation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" } } }, "links": { "GetEquipmentExpanderModuleOperationByMoid": { "operationId": "GetEquipmentExpanderModuleOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.ExpanderModuleOperation' resource.", "operationId": "PatchEquipmentExpanderModuleOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.ExpanderModuleOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.ExpanderModuleOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.ExpanderModuleOperation' resource was patched as requested. The 'equipment.ExpanderModuleOperation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" } } }, "links": { "GetEquipmentExpanderModuleOperationByMoid": { "operationId": "GetEquipmentExpanderModuleOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/ExpanderModuleOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Fans": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fan' resource.", "operationId": "GetEquipmentFanList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.Fan", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Fan' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Fans/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fan' resource.", "operationId": "GetEquipmentFanByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.Fan", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Fan' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFanByMoid": { "operationId": "GetEquipmentFanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fan' resource.", "operationId": "UpdateEquipmentFan", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Fan" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fan' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fan' resource was modified as requested. The 'equipment.Fan' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan" } } }, "links": { "GetEquipmentFanByMoid": { "operationId": "GetEquipmentFanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fan' resource.", "operationId": "PatchEquipmentFan", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Fan" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fan' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fan' resource was patched as requested. The 'equipment.Fan' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fan" } } }, "links": { "GetEquipmentFanByMoid": { "operationId": "GetEquipmentFanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FanControls": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FanControl' resource.", "operationId": "GetEquipmentFanControlList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.FanControl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.FanControl' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FanControls/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FanControl' resource.", "operationId": "GetEquipmentFanControlByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.FanControl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.FanControl' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFanControlByMoid": { "operationId": "GetEquipmentFanControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FanControl' resource.", "operationId": "UpdateEquipmentFanControl", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.FanControl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FanControl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanControl' resource was modified as requested. The 'equipment.FanControl' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl" } } }, "links": { "GetEquipmentFanControlByMoid": { "operationId": "GetEquipmentFanControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FanControl' resource.", "operationId": "PatchEquipmentFanControl", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.FanControl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FanControl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanControl' resource was patched as requested. The 'equipment.FanControl' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanControl" } } }, "links": { "GetEquipmentFanControlByMoid": { "operationId": "GetEquipmentFanControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FanModules": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FanModule' resource.", "operationId": "GetEquipmentFanModuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.FanModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.FanModule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FanModules/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FanModule' resource.", "operationId": "GetEquipmentFanModuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.FanModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.FanModule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFanModuleByMoid": { "operationId": "GetEquipmentFanModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FanModule' resource.", "operationId": "UpdateEquipmentFanModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.FanModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FanModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanModule' resource was modified as requested. The 'equipment.FanModule' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule" } } }, "links": { "GetEquipmentFanModuleByMoid": { "operationId": "GetEquipmentFanModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FanModule' resource.", "operationId": "PatchEquipmentFanModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.FanModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FanModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FanModule' resource was patched as requested. The 'equipment.FanModule' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FanModule" } } }, "links": { "GetEquipmentFanModuleByMoid": { "operationId": "GetEquipmentFanModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FanModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Fexes": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fex' resource.", "operationId": "GetEquipmentFexList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.Fex", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Fex' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Fexes/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fex' resource.", "operationId": "GetEquipmentFexByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.Fex", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Fex' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFexByMoid": { "operationId": "GetEquipmentFexByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fex' resource.", "operationId": "UpdateEquipmentFex", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.Fex" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fex' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fex' resource was modified as requested. The 'equipment.Fex' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex" } } }, "links": { "GetEquipmentFexByMoid": { "operationId": "GetEquipmentFexByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fex' resource.", "operationId": "PatchEquipmentFex", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.Fex" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fex' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fex' resource was patched as requested. The 'equipment.Fex' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fex" } } }, "links": { "GetEquipmentFexByMoid": { "operationId": "GetEquipmentFexByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Fexes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FexIdentities": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FexIdentity' resource.", "operationId": "GetEquipmentFexIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.FexIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.FexIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FexIdentities/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FexIdentity' resource.", "operationId": "GetEquipmentFexIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.FexIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.FexIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFexIdentityByMoid": { "operationId": "GetEquipmentFexIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FexIdentity' resource.", "operationId": "UpdateEquipmentFexIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.FexIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FexIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexIdentity' resource was modified as requested. The 'equipment.FexIdentity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity" } } }, "links": { "GetEquipmentFexIdentityByMoid": { "operationId": "GetEquipmentFexIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FexIdentity' resource.", "operationId": "PatchEquipmentFexIdentity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.FexIdentity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FexIdentity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexIdentity' resource was patched as requested. The 'equipment.FexIdentity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexIdentity" } } }, "links": { "GetEquipmentFexIdentityByMoid": { "operationId": "GetEquipmentFexIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FexOperations": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FexOperation' resource.", "operationId": "GetEquipmentFexOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.FexOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.FexOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/FexOperations/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.FexOperation' resource.", "operationId": "GetEquipmentFexOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.equipment.FexOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.FexOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFexOperationByMoid": { "operationId": "GetEquipmentFexOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FexOperation' resource.", "operationId": "UpdateEquipmentFexOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.FexOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FexOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexOperation' resource was modified as requested. The 'equipment.FexOperation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation" } } }, "links": { "GetEquipmentFexOperationByMoid": { "operationId": "GetEquipmentFexOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.FexOperation' resource.", "operationId": "PatchEquipmentFexOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.FexOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.FexOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.FexOperation' resource was patched as requested. The 'equipment.FexOperation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.FexOperation" } } }, "links": { "GetEquipmentFexOperationByMoid": { "operationId": "GetEquipmentFexOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/FexOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Frus": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fru' resource.", "operationId": "GetEquipmentFruList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.equipment.Fru" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Fru' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Frus/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Fru' resource.", "operationId": "GetEquipmentFruByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.equipment.Fru" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Fru' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentFruByMoid": { "operationId": "GetEquipmentFruByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Frus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fru' resource.", "operationId": "UpdateEquipmentFru", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.equipment.Fru" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fru' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fru' resource was modified as requested. The 'equipment.Fru' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru" } } }, "links": { "GetEquipmentFruByMoid": { "operationId": "GetEquipmentFruByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Frus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Fru' resource.", "operationId": "PatchEquipmentFru", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "UPDATE.equipment.Fru" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Fru' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Fru' resource was patched as requested. The 'equipment.Fru' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Fru" } } }, "links": { "GetEquipmentFruByMoid": { "operationId": "GetEquipmentFruByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Frus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/HybridDriveSlots": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.HybridDriveSlot' resource.", "operationId": "GetEquipmentHybridDriveSlotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.HybridDriveSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.HybridDriveSlot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.HybridDriveSlot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/HybridDriveSlots/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.HybridDriveSlot' resource.", "operationId": "GetEquipmentHybridDriveSlotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.HybridDriveSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.HybridDriveSlot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.HybridDriveSlot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentHybridDriveSlotByMoid": { "operationId": "GetEquipmentHybridDriveSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/HybridDriveSlots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Interconnects": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Interconnect' resource.", "operationId": "GetEquipmentInterconnectList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.Interconnect", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Interconnect' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Interconnect.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Interconnects/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Interconnect' resource.", "operationId": "GetEquipmentInterconnectByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.Interconnect", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Interconnect' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Interconnect" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentInterconnectByMoid": { "operationId": "GetEquipmentInterconnectByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Interconnects/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoCards": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoCard' resource.", "operationId": "GetEquipmentIoCardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.IoCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.IoCard' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoCards/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoCard' resource.", "operationId": "GetEquipmentIoCardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.IoCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.IoCard' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentIoCardByMoid": { "operationId": "GetEquipmentIoCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoCard' resource.", "operationId": "UpdateEquipmentIoCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoCard" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoCard' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCard' resource was modified as requested. The 'equipment.IoCard' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard" } } }, "links": { "GetEquipmentIoCardByMoid": { "operationId": "GetEquipmentIoCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoCard' resource.", "operationId": "PatchEquipmentIoCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoCard" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoCard' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCard' resource was patched as requested. The 'equipment.IoCard' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCard" } } }, "links": { "GetEquipmentIoCardByMoid": { "operationId": "GetEquipmentIoCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoCardOperations": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoCardOperation' resource.", "operationId": "GetEquipmentIoCardOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.View Fabric Interconnects", "READ.equipment.IoCardOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.IoCardOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoCardOperations/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoCardOperation' resource.", "operationId": "GetEquipmentIoCardOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.View Fabric Interconnects", "READ.equipment.IoCardOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.IoCardOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentIoCardOperationByMoid": { "operationId": "GetEquipmentIoCardOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoCardOperation' resource.", "operationId": "UpdateEquipmentIoCardOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoCardOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoCardOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCardOperation' resource was modified as requested. The 'equipment.IoCardOperation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation" } } }, "links": { "GetEquipmentIoCardOperationByMoid": { "operationId": "GetEquipmentIoCardOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoCardOperation' resource.", "operationId": "PatchEquipmentIoCardOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoCardOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoCardOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoCardOperation' resource was patched as requested. The 'equipment.IoCardOperation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoCardOperation" } } }, "links": { "GetEquipmentIoCardOperationByMoid": { "operationId": "GetEquipmentIoCardOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoCardOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoExpanders": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoExpander' resource.", "operationId": "GetEquipmentIoExpanderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.IoExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.IoExpander' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/IoExpanders/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.IoExpander' resource.", "operationId": "GetEquipmentIoExpanderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.IoExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.IoExpander' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentIoExpanderByMoid": { "operationId": "GetEquipmentIoExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoExpander' resource.", "operationId": "UpdateEquipmentIoExpander", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoExpander" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoExpander' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoExpander' resource was modified as requested. The 'equipment.IoExpander' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander" } } }, "links": { "GetEquipmentIoExpanderByMoid": { "operationId": "GetEquipmentIoExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.IoExpander' resource.", "operationId": "PatchEquipmentIoExpander", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.IoExpander" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.IoExpander' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.IoExpander' resource was patched as requested. The 'equipment.IoExpander' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.IoExpander" } } }, "links": { "GetEquipmentIoExpanderByMoid": { "operationId": "GetEquipmentIoExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/IoExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/LocatorLeds": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.LocatorLed' resource.", "operationId": "GetEquipmentLocatorLedList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.LocatorLed", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.LocatorLed' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/LocatorLeds/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.LocatorLed' resource.", "operationId": "GetEquipmentLocatorLedByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.LocatorLed", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.LocatorLed' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentLocatorLedByMoid": { "operationId": "GetEquipmentLocatorLedByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.LocatorLed' resource.", "operationId": "UpdateEquipmentLocatorLed", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.LocatorLed" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.LocatorLed' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.LocatorLed' resource was modified as requested. The 'equipment.LocatorLed' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed" } } }, "links": { "GetEquipmentLocatorLedByMoid": { "operationId": "GetEquipmentLocatorLedByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.LocatorLed' resource.", "operationId": "PatchEquipmentLocatorLed", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.LocatorLed" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.LocatorLed' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.LocatorLed' resource was patched as requested. The 'equipment.LocatorLed' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LocatorLed" } } }, "links": { "GetEquipmentLocatorLedByMoid": { "operationId": "GetEquipmentLocatorLedByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LocatorLeds/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/LogDownloads": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.LogDownload' resource.", "operationId": "GetEquipmentLogDownloadList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Download server event logs", "PRIVSET.Manage Servers", "READ.equipment.LogDownload", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.LogDownload' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LogDownload.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/LogDownloads/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.LogDownload' resource.", "operationId": "GetEquipmentLogDownloadByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Download server event logs", "PRIVSET.Manage Servers", "READ.equipment.LogDownload", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.LogDownload' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.LogDownload" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentLogDownloadByMoid": { "operationId": "GetEquipmentLogDownloadByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/LogDownloads/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Psus": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Psu' resource.", "operationId": "GetEquipmentPsuList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.Psu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Psu' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Psus/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Psu' resource.", "operationId": "GetEquipmentPsuByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.Psu", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Psu' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentPsuByMoid": { "operationId": "GetEquipmentPsuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Psu' resource.", "operationId": "UpdateEquipmentPsu", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Psu" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Psu' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Psu' resource was modified as requested. The 'equipment.Psu' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu" } } }, "links": { "GetEquipmentPsuByMoid": { "operationId": "GetEquipmentPsuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Psu' resource.", "operationId": "PatchEquipmentPsu", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Psu" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Psu' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Psu' resource was patched as requested. The 'equipment.Psu' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Psu" } } }, "links": { "GetEquipmentPsuByMoid": { "operationId": "GetEquipmentPsuByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Psus/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/PsuControls": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.PsuControl' resource.", "operationId": "GetEquipmentPsuControlList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.PsuControl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.PsuControl' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/PsuControls/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.PsuControl' resource.", "operationId": "GetEquipmentPsuControlByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.equipment.PsuControl", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.PsuControl' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentPsuControlByMoid": { "operationId": "GetEquipmentPsuControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.PsuControl' resource.", "operationId": "UpdateEquipmentPsuControl", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.PsuControl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.PsuControl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.PsuControl' resource was modified as requested. The 'equipment.PsuControl' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl" } } }, "links": { "GetEquipmentPsuControlByMoid": { "operationId": "GetEquipmentPsuControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.PsuControl' resource.", "operationId": "PatchEquipmentPsuControl", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.PsuControl" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.PsuControl' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.PsuControl' resource was patched as requested. The 'equipment.PsuControl' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.PsuControl" } } }, "links": { "GetEquipmentPsuControlByMoid": { "operationId": "GetEquipmentPsuControlByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/PsuControls/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/RackEnclosures": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.RackEnclosure' resource.", "operationId": "GetEquipmentRackEnclosureList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.RackEnclosure", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.RackEnclosure' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/RackEnclosures/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.RackEnclosure' resource.", "operationId": "GetEquipmentRackEnclosureByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.RackEnclosure", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.RackEnclosure' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentRackEnclosureByMoid": { "operationId": "GetEquipmentRackEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.RackEnclosure' resource.", "operationId": "UpdateEquipmentRackEnclosure", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.RackEnclosure" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.RackEnclosure' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosure' resource was modified as requested. The 'equipment.RackEnclosure' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure" } } }, "links": { "GetEquipmentRackEnclosureByMoid": { "operationId": "GetEquipmentRackEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.RackEnclosure' resource.", "operationId": "PatchEquipmentRackEnclosure", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.RackEnclosure" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.RackEnclosure' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosure' resource was patched as requested. The 'equipment.RackEnclosure' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosure" } } }, "links": { "GetEquipmentRackEnclosureByMoid": { "operationId": "GetEquipmentRackEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/RackEnclosureSlots": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.RackEnclosureSlot' resource.", "operationId": "GetEquipmentRackEnclosureSlotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.RackEnclosureSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.RackEnclosureSlot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/RackEnclosureSlots/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.RackEnclosureSlot' resource.", "operationId": "GetEquipmentRackEnclosureSlotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.RackEnclosureSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.RackEnclosureSlot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentRackEnclosureSlotByMoid": { "operationId": "GetEquipmentRackEnclosureSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.RackEnclosureSlot' resource.", "operationId": "UpdateEquipmentRackEnclosureSlot", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.RackEnclosureSlot" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.RackEnclosureSlot' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosureSlot' resource was modified as requested. The 'equipment.RackEnclosureSlot' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } } }, "links": { "GetEquipmentRackEnclosureSlotByMoid": { "operationId": "GetEquipmentRackEnclosureSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.RackEnclosureSlot' resource.", "operationId": "PatchEquipmentRackEnclosureSlot", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.RackEnclosureSlot" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.RackEnclosureSlot' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.RackEnclosureSlot' resource was patched as requested. The 'equipment.RackEnclosureSlot' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } } }, "links": { "GetEquipmentRackEnclosureSlotByMoid": { "operationId": "GetEquipmentRackEnclosureSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/RackEnclosureSlots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Risers": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Riser' resource.", "operationId": "GetEquipmentRiserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.Riser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Riser' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Riser.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Risers/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Riser' resource.", "operationId": "GetEquipmentRiserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.Riser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Riser' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Riser" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentRiserByMoid": { "operationId": "GetEquipmentRiserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Risers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Sensors": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Sensor' resource.", "operationId": "GetEquipmentSensorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Network Switches", "READ.equipment.Sensor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Sensor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Sensor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Sensors/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Sensor' resource.", "operationId": "GetEquipmentSensorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Network Switches", "READ.equipment.Sensor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Sensor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Sensor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSensorByMoid": { "operationId": "GetEquipmentSensorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Sensors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedAdapterUnits": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedAdapterUnit' resource.", "operationId": "GetEquipmentSharedAdapterUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.SharedAdapterUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SharedAdapterUnit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedAdapterUnits/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedAdapterUnit' resource.", "operationId": "GetEquipmentSharedAdapterUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.SharedAdapterUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SharedAdapterUnit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSharedAdapterUnitByMoid": { "operationId": "GetEquipmentSharedAdapterUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedAdapterUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedGraphicsCards": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedGraphicsCard' resource.", "operationId": "GetEquipmentSharedGraphicsCardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.SharedGraphicsCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SharedGraphicsCard' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedGraphicsCards/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedGraphicsCard' resource.", "operationId": "GetEquipmentSharedGraphicsCardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.equipment.SharedGraphicsCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SharedGraphicsCard' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSharedGraphicsCardByMoid": { "operationId": "GetEquipmentSharedGraphicsCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedGraphicsCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedIoModules": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedIoModule' resource.", "operationId": "GetEquipmentSharedIoModuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.SharedIoModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SharedIoModule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SharedIoModules/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SharedIoModule' resource.", "operationId": "GetEquipmentSharedIoModuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.SharedIoModule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SharedIoModule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSharedIoModuleByMoid": { "operationId": "GetEquipmentSharedIoModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SharedIoModule' resource.", "operationId": "UpdateEquipmentSharedIoModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.SharedIoModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SharedIoModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SharedIoModule' resource was modified as requested. The 'equipment.SharedIoModule' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule" } } }, "links": { "GetEquipmentSharedIoModuleByMoid": { "operationId": "GetEquipmentSharedIoModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SharedIoModule' resource.", "operationId": "PatchEquipmentSharedIoModule", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.SharedIoModule" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SharedIoModule' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SharedIoModule' resource was patched as requested. The 'equipment.SharedIoModule' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SharedIoModule" } } }, "links": { "GetEquipmentSharedIoModuleByMoid": { "operationId": "GetEquipmentSharedIoModuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SharedIoModules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SwitchCards": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SwitchCard' resource.", "operationId": "GetEquipmentSwitchCardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "READ.equipment.SwitchCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SwitchCard' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SwitchCards/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SwitchCard' resource.", "operationId": "GetEquipmentSwitchCardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "READ.equipment.SwitchCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SwitchCard' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSwitchCardByMoid": { "operationId": "GetEquipmentSwitchCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SwitchCard' resource.", "operationId": "UpdateEquipmentSwitchCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.SwitchCard" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SwitchCard' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchCard' resource was modified as requested. The 'equipment.SwitchCard' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard" } } }, "links": { "GetEquipmentSwitchCardByMoid": { "operationId": "GetEquipmentSwitchCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SwitchCard' resource.", "operationId": "PatchEquipmentSwitchCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.SwitchCard" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SwitchCard' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchCard' resource was patched as requested. The 'equipment.SwitchCard' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchCard" } } }, "links": { "GetEquipmentSwitchCardByMoid": { "operationId": "GetEquipmentSwitchCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SwitchOperations": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SwitchOperation' resource.", "operationId": "GetEquipmentSwitchOperationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Fabric Interconnects", "READ.equipment.SwitchOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SwitchOperation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SwitchOperations/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SwitchOperation' resource.", "operationId": "GetEquipmentSwitchOperationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Fabric Interconnects", "READ.equipment.SwitchOperation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SwitchOperation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSwitchOperationByMoid": { "operationId": "GetEquipmentSwitchOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SwitchOperation' resource.", "operationId": "UpdateEquipmentSwitchOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.SwitchOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SwitchOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchOperation' resource was modified as requested. The 'equipment.SwitchOperation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation" } } }, "links": { "GetEquipmentSwitchOperationByMoid": { "operationId": "GetEquipmentSwitchOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SwitchOperation' resource.", "operationId": "PatchEquipmentSwitchOperation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.equipment.SwitchOperation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SwitchOperation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SwitchOperation' resource was patched as requested. The 'equipment.SwitchOperation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SwitchOperation" } } }, "links": { "GetEquipmentSwitchOperationByMoid": { "operationId": "GetEquipmentSwitchOperationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SwitchOperations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SystemIoControllers": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SystemIoController' resource.", "operationId": "GetEquipmentSystemIoControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.SystemIoController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.SystemIoController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/SystemIoControllers/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.SystemIoController' resource.", "operationId": "GetEquipmentSystemIoControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.SystemIoController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.SystemIoController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentSystemIoControllerByMoid": { "operationId": "GetEquipmentSystemIoControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SystemIoController' resource.", "operationId": "UpdateEquipmentSystemIoController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.SystemIoController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SystemIoController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SystemIoController' resource was modified as requested. The 'equipment.SystemIoController' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController" } } }, "links": { "GetEquipmentSystemIoControllerByMoid": { "operationId": "GetEquipmentSystemIoControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.SystemIoController' resource.", "operationId": "PatchEquipmentSystemIoController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.SystemIoController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.SystemIoController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.SystemIoController' resource was patched as requested. The 'equipment.SystemIoController' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.SystemIoController" } } }, "links": { "GetEquipmentSystemIoControllerByMoid": { "operationId": "GetEquipmentSystemIoControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/SystemIoControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Tpms": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Tpm' resource.", "operationId": "GetEquipmentTpmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.Tpm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Tpm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Tpms/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Tpm' resource.", "operationId": "GetEquipmentTpmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.equipment.Tpm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Tpm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentTpmByMoid": { "operationId": "GetEquipmentTpmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Tpm' resource.", "operationId": "UpdateEquipmentTpm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Tpm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Tpm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Tpm' resource was modified as requested. The 'equipment.Tpm' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm" } } }, "links": { "GetEquipmentTpmByMoid": { "operationId": "GetEquipmentTpmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Tpm' resource.", "operationId": "PatchEquipmentTpm", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Tpm" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Tpm' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Tpm' resource was patched as requested. The 'equipment.Tpm' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Tpm" } } }, "links": { "GetEquipmentTpmByMoid": { "operationId": "GetEquipmentTpmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Tpms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Transceivers": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Transceiver' resource.", "operationId": "GetEquipmentTransceiverList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.Transceiver", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'equipment.Transceiver' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/equipment/Transceivers/{Moid}": { "get": { "tags": [ "equipment" ], "summary": "Read a 'equipment.Transceiver' resource.", "operationId": "GetEquipmentTransceiverByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.equipment.Transceiver", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'equipment.Transceiver' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetEquipmentTransceiverByMoid": { "operationId": "GetEquipmentTransceiverByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Transceiver' resource.", "operationId": "UpdateEquipmentTransceiver", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Transceiver" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Transceiver' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Transceiver' resource was modified as requested. The 'equipment.Transceiver' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver" } } }, "links": { "GetEquipmentTransceiverByMoid": { "operationId": "GetEquipmentTransceiverByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "equipment" ], "summary": "Update a 'equipment.Transceiver' resource.", "operationId": "PatchEquipmentTransceiver", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.equipment.Transceiver" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'equipment.Transceiver' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'equipment.Transceiver' resource was patched as requested. The 'equipment.Transceiver' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/equipment.Transceiver" } } }, "links": { "GetEquipmentTransceiverByMoid": { "operationId": "GetEquipmentTransceiverByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/equipment/Transceivers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fault/Instances": { "get": { "tags": [ "fault" ], "summary": "Read a 'fault.Instance' resource.", "operationId": "GetFaultInstanceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.fault.Instance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fault.Instance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fault/Instances/{Moid}": { "get": { "tags": [ "fault" ], "summary": "Read a 'fault.Instance' resource.", "operationId": "GetFaultInstanceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.fault.Instance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fault.Instance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFaultInstanceByMoid": { "operationId": "GetFaultInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "fault" ], "summary": "Update a 'fault.Instance' resource.", "operationId": "UpdateFaultInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.fault.Instance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fault.Instance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fault.Instance' resource was modified as requested. The 'fault.Instance' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance" } } }, "links": { "GetFaultInstanceByMoid": { "operationId": "GetFaultInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "fault" ], "summary": "Update a 'fault.Instance' resource.", "operationId": "PatchFaultInstance", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.fault.Instance" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fault.Instance' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fault.Instance' resource was patched as requested. The 'fault.Instance' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fault.Instance" } } }, "links": { "GetFaultInstanceByMoid": { "operationId": "GetFaultInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fault/Instances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/FcBlocks": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.FcBlock' resource.", "operationId": "GetFcpoolFcBlockList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.FcBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.FcBlock' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.FcBlock.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/FcBlocks/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.FcBlock' resource.", "operationId": "GetFcpoolFcBlockByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.FcBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.FcBlock' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.FcBlock" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolFcBlockByMoid": { "operationId": "GetFcpoolFcBlockByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/FcBlocks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Leases": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Lease' resource.", "operationId": "GetFcpoolLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.Lease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Lease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Leases/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Lease' resource.", "operationId": "GetFcpoolLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.Lease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Lease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolLeaseByMoid": { "operationId": "GetFcpoolLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Leases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "fcpool" ], "summary": "Delete a 'fcpool.Lease' resource.", "operationId": "DeleteFcpoolLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.fcpool.Lease", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Pools": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Pool' resource.", "operationId": "GetFcpoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.Pool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "fcpool" ], "summary": "Create a 'fcpool.Pool' resource.", "operationId": "CreateFcpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.fcpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create WWNN or WWPN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'fcpool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Pool' resource was created as requested. The 'fcpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } } }, "links": { "GetFcpoolPoolByMoid": { "operationId": "GetFcpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Pools/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Pool' resource.", "operationId": "GetFcpoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.Pool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolPoolByMoid": { "operationId": "GetFcpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "fcpool" ], "summary": "Update a 'fcpool.Pool' resource.", "operationId": "UpdateFcpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit WWNN or WWPN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.fcpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fcpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Pool' resource was modified as requested. The 'fcpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } } }, "links": { "GetFcpoolPoolByMoid": { "operationId": "GetFcpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "fcpool" ], "summary": "Update a 'fcpool.Pool' resource.", "operationId": "PatchFcpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit WWNN or WWPN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.fcpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fcpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Pool' resource was patched as requested. The 'fcpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Pool" } } }, "links": { "GetFcpoolPoolByMoid": { "operationId": "GetFcpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "fcpool" ], "summary": "Delete a 'fcpool.Pool' resource.", "operationId": "DeleteFcpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.fcpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete WWNN or WWPN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/PoolMembers": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.PoolMember' resource.", "operationId": "GetFcpoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.PoolMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/PoolMembers/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.PoolMember' resource.", "operationId": "GetFcpoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.PoolMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.PoolMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolPoolMemberByMoid": { "operationId": "GetFcpoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/PoolMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Reservations": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Reservation' resource.", "operationId": "GetFcpoolReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "fcpool" ], "summary": "Create a 'fcpool.Reservation' resource.", "operationId": "CreateFcpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.fcpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Create WWNN and WWPN pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'fcpool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Reservation' resource was created as requested. The 'fcpool.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } } }, "links": { "GetFcpoolReservationByMoid": { "operationId": "GetFcpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Reservations/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Reservation' resource.", "operationId": "GetFcpoolReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolReservationByMoid": { "operationId": "GetFcpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "fcpool" ], "summary": "Delete a 'fcpool.Reservation' resource.", "operationId": "DeleteFcpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.fcpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Delete WWNN and WWPN pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "fcpool" ], "summary": "Update a 'fcpool.Reservation' resource.", "operationId": "UpdateFcpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.fcpool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fcpool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Reservation' resource was modified as requested. The 'fcpool.Reservation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } } }, "links": { "GetFcpoolReservationByMoid": { "operationId": "GetFcpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "fcpool" ], "summary": "Update a 'fcpool.Reservation' resource.", "operationId": "PatchFcpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.fcpool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'fcpool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'fcpool.Reservation' resource was patched as requested. The 'fcpool.Reservation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Reservation" } } }, "links": { "GetFcpoolReservationByMoid": { "operationId": "GetFcpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Universes": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Universe' resource.", "operationId": "GetFcpoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'fcpool.Universe' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/fcpool/Universes/{Moid}": { "get": { "tags": [ "fcpool" ], "summary": "Read a 'fcpool.Universe' resource.", "operationId": "GetFcpoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.fcpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'fcpool.Universe' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fcpool.Universe" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFcpoolUniverseByMoid": { "operationId": "GetFcpoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/fcpool/Universes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/BiosDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.BiosDescriptor' resource.", "operationId": "GetFirmwareBiosDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.BiosDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.BiosDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.BiosDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/BiosDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.BiosDescriptor' resource.", "operationId": "GetFirmwareBiosDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.BiosDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.BiosDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.BiosDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareBiosDescriptorByMoid": { "operationId": "GetFirmwareBiosDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BiosDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/BoardControllerDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.BoardControllerDescriptor' resource.", "operationId": "GetFirmwareBoardControllerDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.BoardControllerDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.BoardControllerDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.BoardControllerDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/BoardControllerDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.BoardControllerDescriptor' resource.", "operationId": "GetFirmwareBoardControllerDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.BoardControllerDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.BoardControllerDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.BoardControllerDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareBoardControllerDescriptorByMoid": { "operationId": "GetFirmwareBoardControllerDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/BoardControllerDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/ChassisUpgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.ChassisUpgrade' resource.", "operationId": "GetFirmwareChassisUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Upgrade chassis firmware", "PRIVSET.View Servers", "READ.firmware.ChassisUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.ChassisUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ChassisUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.ChassisUpgrade' resource.", "operationId": "CreateFirmwareChassisUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.ChassisUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade chassis firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.ChassisUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ChassisUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ChassisUpgrade' resource was created as requested. The 'firmware.ChassisUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ChassisUpgrade" } } }, "links": { "GetFirmwareChassisUpgradeByMoid": { "operationId": "GetFirmwareChassisUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ChassisUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/ChassisUpgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.ChassisUpgrade' resource.", "operationId": "GetFirmwareChassisUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Upgrade chassis firmware", "PRIVSET.View Servers", "READ.firmware.ChassisUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.ChassisUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ChassisUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareChassisUpgradeByMoid": { "operationId": "GetFirmwareChassisUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ChassisUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.ChassisUpgrade' resource.", "operationId": "DeleteFirmwareChassisUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.ChassisUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade chassis firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/CimcDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.CimcDescriptor' resource.", "operationId": "GetFirmwareCimcDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.CimcDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.CimcDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.CimcDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/CimcDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.CimcDescriptor' resource.", "operationId": "GetFirmwareCimcDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.CimcDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.CimcDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.CimcDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareCimcDescriptorByMoid": { "operationId": "GetFirmwareCimcDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/CimcDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DimmDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DimmDescriptor' resource.", "operationId": "GetFirmwareDimmDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.DimmDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.DimmDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DimmDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DimmDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DimmDescriptor' resource.", "operationId": "GetFirmwareDimmDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.DimmDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.DimmDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DimmDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareDimmDescriptorByMoid": { "operationId": "GetFirmwareDimmDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DimmDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Distributables": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Distributable' resource.", "operationId": "GetFirmwareDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add firmware links", "PRIVSET.Delete firmware links", "PRIVSET.Edit firmware links", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only Firmware policies", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "READ.firmware.Distributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.Distributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.Distributable' resource.", "operationId": "CreateFirmwareDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.Distributable", "PRIVSET.Account Administrator", "PRIVSET.Add firmware links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.Distributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was created as requested. The 'firmware.Distributable' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } } }, "links": { "GetFirmwareDistributableByMoid": { "operationId": "GetFirmwareDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Distributables/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Distributable' resource.", "operationId": "GetFirmwareDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add firmware links", "PRIVSET.Delete firmware links", "PRIVSET.Edit firmware links", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only Firmware policies", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "READ.firmware.Distributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.Distributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareDistributableByMoid": { "operationId": "GetFirmwareDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Distributable' resource.", "operationId": "UpdateFirmwareDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit firmware links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.Distributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Distributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was modified as requested. The 'firmware.Distributable' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } } }, "links": { "GetFirmwareDistributableByMoid": { "operationId": "GetFirmwareDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Distributable' resource.", "operationId": "PatchFirmwareDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit firmware links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.Distributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Distributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Distributable' resource was patched as requested. The 'firmware.Distributable' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Distributable" } } }, "links": { "GetFirmwareDistributableByMoid": { "operationId": "GetFirmwareDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Distributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.Distributable' resource.", "operationId": "DeleteFirmwareDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.Distributable", "PRIVSET.Account Administrator", "PRIVSET.Delete firmware links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DistributableMeta": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DistributableMeta' resource.", "operationId": "GetFirmwareDistributableMetaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.firmware.DistributableMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.DistributableMeta' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DistributableMeta.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DistributableMeta/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DistributableMeta' resource.", "operationId": "GetFirmwareDistributableMetaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.firmware.DistributableMeta", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.DistributableMeta' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DistributableMeta" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareDistributableMetaByMoid": { "operationId": "GetFirmwareDistributableMetaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DistributableMeta/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DriveDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DriveDescriptor' resource.", "operationId": "GetFirmwareDriveDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.DriveDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.DriveDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriveDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DriveDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DriveDescriptor' resource.", "operationId": "GetFirmwareDriveDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.DriveDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.DriveDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriveDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareDriveDescriptorByMoid": { "operationId": "GetFirmwareDriveDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriveDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DriverDistributables": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.DriverDistributable' resource.", "operationId": "CreateFirmwareDriverDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.DriverDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.DriverDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was created as requested. The 'firmware.DriverDistributable' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } } }, "links": { "GetFirmwareDriverDistributableByMoid": { "operationId": "GetFirmwareDriverDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DriverDistributable' resource.", "operationId": "GetFirmwareDriverDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.firmware.DriverDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.DriverDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/DriverDistributables/{Moid}": { "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.DriverDistributable' resource.", "operationId": "UpdateFirmwareDriverDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.DriverDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.DriverDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was modified as requested. The 'firmware.DriverDistributable' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } } }, "links": { "GetFirmwareDriverDistributableByMoid": { "operationId": "GetFirmwareDriverDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.DriverDistributable' resource.", "operationId": "PatchFirmwareDriverDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.DriverDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.DriverDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.DriverDistributable' resource was patched as requested. The 'firmware.DriverDistributable' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } } }, "links": { "GetFirmwareDriverDistributableByMoid": { "operationId": "GetFirmwareDriverDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.DriverDistributable' resource.", "operationId": "GetFirmwareDriverDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "READ.firmware.DriverDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.DriverDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.DriverDistributable" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareDriverDistributableByMoid": { "operationId": "GetFirmwareDriverDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/DriverDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.DriverDistributable' resource.", "operationId": "DeleteFirmwareDriverDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.DriverDistributable", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Eulas": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.Eula' resource.", "operationId": "CreateFirmwareEula", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.Eula", "PRIVSET.Account Administrator", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Configure MFA", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.Eula' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Eula" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Eula' resource was created as requested. The 'firmware.Eula' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Eula" } } }, "links": { "GetFirmwareEulaByMoid": { "operationId": "GetFirmwareEulaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Eula' resource.", "operationId": "GetFirmwareEulaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Configure MFA", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.firmware.Eula", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.Eula' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Eula.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Eulas/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Eula' resource.", "operationId": "GetFirmwareEulaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure Cisco software download credentials", "PRIVSET.Configure MFA", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "READ.firmware.Eula", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.Eula' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Eula" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareEulaByMoid": { "operationId": "GetFirmwareEulaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Eulas/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/FirmwareSummaries": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.FirmwareSummary' resource.", "operationId": "GetFirmwareFirmwareSummaryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.firmware.FirmwareSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.FirmwareSummary' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.FirmwareSummary.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/FirmwareSummaries/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.FirmwareSummary' resource.", "operationId": "GetFirmwareFirmwareSummaryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.firmware.FirmwareSummary", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.FirmwareSummary' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.FirmwareSummary" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareFirmwareSummaryByMoid": { "operationId": "GetFirmwareFirmwareSummaryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/FirmwareSummaries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/GpuDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.GpuDescriptor' resource.", "operationId": "GetFirmwareGpuDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.GpuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.GpuDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.GpuDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/GpuDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.GpuDescriptor' resource.", "operationId": "GetFirmwareGpuDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.GpuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.GpuDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.GpuDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareGpuDescriptorByMoid": { "operationId": "GetFirmwareGpuDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/GpuDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/HbaDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.HbaDescriptor' resource.", "operationId": "GetFirmwareHbaDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.HbaDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.HbaDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.HbaDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/HbaDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.HbaDescriptor' resource.", "operationId": "GetFirmwareHbaDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.HbaDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.HbaDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.HbaDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareHbaDescriptorByMoid": { "operationId": "GetFirmwareHbaDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/HbaDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/IomDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.IomDescriptor' resource.", "operationId": "GetFirmwareIomDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.IomDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.IomDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.IomDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/IomDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.IomDescriptor' resource.", "operationId": "GetFirmwareIomDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.IomDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.IomDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.IomDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareIomDescriptorByMoid": { "operationId": "GetFirmwareIomDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/IomDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/MswitchDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.MswitchDescriptor' resource.", "operationId": "GetFirmwareMswitchDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.MswitchDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.MswitchDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.MswitchDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/MswitchDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.MswitchDescriptor' resource.", "operationId": "GetFirmwareMswitchDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.MswitchDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.MswitchDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.MswitchDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareMswitchDescriptorByMoid": { "operationId": "GetFirmwareMswitchDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/MswitchDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/NxosDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.NxosDescriptor' resource.", "operationId": "GetFirmwareNxosDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.NxosDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.NxosDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.NxosDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/NxosDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.NxosDescriptor' resource.", "operationId": "GetFirmwareNxosDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.NxosDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.NxosDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.NxosDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareNxosDescriptorByMoid": { "operationId": "GetFirmwareNxosDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/NxosDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PciNodeUpgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PciNodeUpgrade' resource.", "operationId": "GetFirmwarePciNodeUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.firmware.PciNodeUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.PciNodeUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PciNodeUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.PciNodeUpgrade' resource.", "operationId": "CreateFirmwarePciNodeUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.PciNodeUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.PciNodeUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PciNodeUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.PciNodeUpgrade' resource was created as requested. The 'firmware.PciNodeUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PciNodeUpgrade" } } }, "links": { "GetFirmwarePciNodeUpgradeByMoid": { "operationId": "GetFirmwarePciNodeUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PciNodeUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PciNodeUpgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PciNodeUpgrade' resource.", "operationId": "GetFirmwarePciNodeUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.firmware.PciNodeUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.PciNodeUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PciNodeUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwarePciNodeUpgradeByMoid": { "operationId": "GetFirmwarePciNodeUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PciNodeUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.PciNodeUpgrade' resource.", "operationId": "DeleteFirmwarePciNodeUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.PciNodeUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PcieDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PcieDescriptor' resource.", "operationId": "GetFirmwarePcieDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PcieDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.PcieDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PcieDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PcieDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PcieDescriptor' resource.", "operationId": "GetFirmwarePcieDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PcieDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.PcieDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PcieDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwarePcieDescriptorByMoid": { "operationId": "GetFirmwarePcieDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PcieDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Policies": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.Policy' resource.", "operationId": "CreateFirmwarePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Firmware policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Policy' resource was created as requested. The 'firmware.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } } }, "links": { "GetFirmwarePolicyByMoid": { "operationId": "GetFirmwarePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Policy' resource.", "operationId": "GetFirmwarePolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Firmware policies", "PRIVSET.View Server Profiles", "READ.firmware.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Policies/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Policy' resource.", "operationId": "GetFirmwarePolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Firmware policies", "PRIVSET.View Server Profiles", "READ.firmware.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwarePolicyByMoid": { "operationId": "GetFirmwarePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Policy' resource.", "operationId": "UpdateFirmwarePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Firmware policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.firmware.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Policy' resource was modified as requested. The 'firmware.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } } }, "links": { "GetFirmwarePolicyByMoid": { "operationId": "GetFirmwarePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Policy' resource.", "operationId": "PatchFirmwarePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Firmware policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.firmware.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Policy' resource was patched as requested. The 'firmware.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Policy" } } }, "links": { "GetFirmwarePolicyByMoid": { "operationId": "GetFirmwarePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.Policy' resource.", "operationId": "DeleteFirmwarePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Firmware policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PsuDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PsuDescriptor' resource.", "operationId": "GetFirmwarePsuDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PsuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.PsuDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PsuDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PsuDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PsuDescriptor' resource.", "operationId": "GetFirmwarePsuDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PsuDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.PsuDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PsuDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwarePsuDescriptorByMoid": { "operationId": "GetFirmwarePsuDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsuDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PsxDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PsxDescriptor' resource.", "operationId": "GetFirmwarePsxDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PsxDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.PsxDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PsxDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/PsxDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.PsxDescriptor' resource.", "operationId": "GetFirmwarePsxDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.PsxDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.PsxDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.PsxDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwarePsxDescriptorByMoid": { "operationId": "GetFirmwarePsxDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/PsxDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/RunningFirmwares": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.RunningFirmware' resource.", "operationId": "GetFirmwareRunningFirmwareList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.RunningFirmware", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.RunningFirmware' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/RunningFirmwares/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.RunningFirmware' resource.", "operationId": "GetFirmwareRunningFirmwareByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.RunningFirmware", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.RunningFirmware' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareRunningFirmwareByMoid": { "operationId": "GetFirmwareRunningFirmwareByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.RunningFirmware' resource.", "operationId": "UpdateFirmwareRunningFirmware", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.RunningFirmware" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.RunningFirmware' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.RunningFirmware' resource was modified as requested. The 'firmware.RunningFirmware' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware" } } }, "links": { "GetFirmwareRunningFirmwareByMoid": { "operationId": "GetFirmwareRunningFirmwareByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.RunningFirmware' resource.", "operationId": "PatchFirmwareRunningFirmware", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.RunningFirmware" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.RunningFirmware' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.RunningFirmware' resource was patched as requested. The 'firmware.RunningFirmware' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.RunningFirmware" } } }, "links": { "GetFirmwareRunningFirmwareByMoid": { "operationId": "GetFirmwareRunningFirmwareByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/RunningFirmwares/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SasExpanderDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SasExpanderDescriptor' resource.", "operationId": "GetFirmwareSasExpanderDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.SasExpanderDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.SasExpanderDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SasExpanderDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SasExpanderDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SasExpanderDescriptor' resource.", "operationId": "GetFirmwareSasExpanderDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.SasExpanderDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.SasExpanderDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SasExpanderDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareSasExpanderDescriptorByMoid": { "operationId": "GetFirmwareSasExpanderDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SasExpanderDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SecureRouterUpgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SecureRouterUpgrade' resource.", "operationId": "GetFirmwareSecureRouterUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.View Unified Edge", "READ.firmware.SecureRouterUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.SecureRouterUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.SecureRouterUpgrade' resource.", "operationId": "CreateFirmwareSecureRouterUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.SecureRouterUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.SecureRouterUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SecureRouterUpgrade' resource was created as requested. The 'firmware.SecureRouterUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade" } } }, "links": { "GetFirmwareSecureRouterUpgradeByMoid": { "operationId": "GetFirmwareSecureRouterUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SecureRouterUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SecureRouterUpgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SecureRouterUpgrade' resource.", "operationId": "GetFirmwareSecureRouterUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.View Unified Edge", "READ.firmware.SecureRouterUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.SecureRouterUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareSecureRouterUpgradeByMoid": { "operationId": "GetFirmwareSecureRouterUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SecureRouterUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.SecureRouterUpgrade' resource.", "operationId": "DeleteFirmwareSecureRouterUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.SecureRouterUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Unified Edge", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/ServerConfigurationUtilityDistributables": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "CreateFirmwareServerConfigurationUtilityDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.ServerConfigurationUtilityDistributable", "PRIVSET.Account Administrator", "PRIVSET.Add SCU links", "PRIVSET.Create, clone and edit Firmware policies", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.ServerConfigurationUtilityDistributable' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was created as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } } }, "links": { "GetFirmwareServerConfigurationUtilityDistributableByMoid": { "operationId": "GetFirmwareServerConfigurationUtilityDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "GetFirmwareServerConfigurationUtilityDistributableList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add SCU links", "PRIVSET.Delete SCU links", "PRIVSET.Edit SCU links", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Firmware policies", "PRIVSET.Read-only servers", "READ.firmware.ServerConfigurationUtilityDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.ServerConfigurationUtilityDistributable' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}": { "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "UpdateFirmwareServerConfigurationUtilityDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Firmware policies", "PRIVSET.Edit SCU links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.ServerConfigurationUtilityDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.ServerConfigurationUtilityDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was modified as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } } }, "links": { "GetFirmwareServerConfigurationUtilityDistributableByMoid": { "operationId": "GetFirmwareServerConfigurationUtilityDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "PatchFirmwareServerConfigurationUtilityDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Firmware policies", "PRIVSET.Edit SCU links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.ServerConfigurationUtilityDistributable" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.ServerConfigurationUtilityDistributable' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.ServerConfigurationUtilityDistributable' resource was patched as requested. The 'firmware.ServerConfigurationUtilityDistributable' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } } }, "links": { "GetFirmwareServerConfigurationUtilityDistributableByMoid": { "operationId": "GetFirmwareServerConfigurationUtilityDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "GetFirmwareServerConfigurationUtilityDistributableByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add SCU links", "PRIVSET.Delete SCU links", "PRIVSET.Edit SCU links", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Firmware policies", "PRIVSET.Read-only servers", "READ.firmware.ServerConfigurationUtilityDistributable", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.ServerConfigurationUtilityDistributable' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareServerConfigurationUtilityDistributableByMoid": { "operationId": "GetFirmwareServerConfigurationUtilityDistributableByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/ServerConfigurationUtilityDistributables/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.ServerConfigurationUtilityDistributable' resource.", "operationId": "DeleteFirmwareServerConfigurationUtilityDistributable", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.ServerConfigurationUtilityDistributable", "PRIVSET.Account Administrator", "PRIVSET.Delete Firmware policies", "PRIVSET.Delete SCU links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/StorageControllerDescriptors": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.StorageControllerDescriptor' resource.", "operationId": "GetFirmwareStorageControllerDescriptorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.StorageControllerDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.StorageControllerDescriptor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.StorageControllerDescriptor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/StorageControllerDescriptors/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.StorageControllerDescriptor' resource.", "operationId": "GetFirmwareStorageControllerDescriptorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Read-Only", "READ.firmware.StorageControllerDescriptor", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.StorageControllerDescriptor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.StorageControllerDescriptor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareStorageControllerDescriptorByMoid": { "operationId": "GetFirmwareStorageControllerDescriptorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/StorageControllerDescriptors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SwitchUpgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SwitchUpgrade' resource.", "operationId": "GetFirmwareSwitchUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.firmware.SwitchUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.SwitchUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SwitchUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.SwitchUpgrade' resource.", "operationId": "CreateFirmwareSwitchUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.SwitchUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Upgrade domain firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.SwitchUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SwitchUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.SwitchUpgrade' resource was created as requested. The 'firmware.SwitchUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SwitchUpgrade" } } }, "links": { "GetFirmwareSwitchUpgradeByMoid": { "operationId": "GetFirmwareSwitchUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SwitchUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/SwitchUpgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.SwitchUpgrade' resource.", "operationId": "GetFirmwareSwitchUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Unified Edge", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Unified Edge", "READ.firmware.SwitchUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.SwitchUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.SwitchUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareSwitchUpgradeByMoid": { "operationId": "GetFirmwareSwitchUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/SwitchUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.SwitchUpgrade' resource.", "operationId": "DeleteFirmwareSwitchUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.SwitchUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Upgrade domain firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UnsupportedVersionUpgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "GetFirmwareUnsupportedVersionUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.firmware.UnsupportedVersionUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.UnsupportedVersionUpgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "CreateFirmwareUnsupportedVersionUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.UnsupportedVersionUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.UnsupportedVersionUpgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UnsupportedVersionUpgrade' resource was created as requested. The 'firmware.UnsupportedVersionUpgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } } }, "links": { "GetFirmwareUnsupportedVersionUpgradeByMoid": { "operationId": "GetFirmwareUnsupportedVersionUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UnsupportedVersionUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UnsupportedVersionUpgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "GetFirmwareUnsupportedVersionUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.firmware.UnsupportedVersionUpgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.UnsupportedVersionUpgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareUnsupportedVersionUpgradeByMoid": { "operationId": "GetFirmwareUnsupportedVersionUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UnsupportedVersionUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "UpdateFirmwareUnsupportedVersionUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.UnsupportedVersionUpgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.UnsupportedVersionUpgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UnsupportedVersionUpgrade' resource was modified as requested. The 'firmware.UnsupportedVersionUpgrade' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } } }, "links": { "GetFirmwareUnsupportedVersionUpgradeByMoid": { "operationId": "GetFirmwareUnsupportedVersionUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UnsupportedVersionUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "PatchFirmwareUnsupportedVersionUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.firmware.UnsupportedVersionUpgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.UnsupportedVersionUpgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UnsupportedVersionUpgrade' resource was patched as requested. The 'firmware.UnsupportedVersionUpgrade' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" } } }, "links": { "GetFirmwareUnsupportedVersionUpgradeByMoid": { "operationId": "GetFirmwareUnsupportedVersionUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UnsupportedVersionUpgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.UnsupportedVersionUpgrade' resource.", "operationId": "DeleteFirmwareUnsupportedVersionUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.UnsupportedVersionUpgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Upgrades": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Upgrade' resource.", "operationId": "GetFirmwareUpgradeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.firmware.Upgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.Upgrade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.Upgrade' resource.", "operationId": "CreateFirmwareUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.Upgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade server firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.Upgrade' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Upgrade' resource was created as requested. The 'firmware.Upgrade' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } } }, "links": { "GetFirmwareUpgradeByMoid": { "operationId": "GetFirmwareUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/Upgrades/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.Upgrade' resource.", "operationId": "GetFirmwareUpgradeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.firmware.Upgrade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.Upgrade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareUpgradeByMoid": { "operationId": "GetFirmwareUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "firmware" ], "summary": "Delete a 'firmware.Upgrade' resource.", "operationId": "DeleteFirmwareUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.firmware.Upgrade", "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade server firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Upgrade' resource.", "operationId": "UpdateFirmwareUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade server firmware", "ROLE.Account Administrator", "UPDATE.firmware.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Upgrade' resource was modified as requested. The 'firmware.Upgrade' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } } }, "links": { "GetFirmwareUpgradeByMoid": { "operationId": "GetFirmwareUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "firmware" ], "summary": "Update a 'firmware.Upgrade' resource.", "operationId": "PatchFirmwareUpgrade", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Upgrade server firmware", "ROLE.Account Administrator", "UPDATE.firmware.Upgrade" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'firmware.Upgrade' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.Upgrade' resource was patched as requested. The 'firmware.Upgrade' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.Upgrade" } } }, "links": { "GetFirmwareUpgradeByMoid": { "operationId": "GetFirmwareUpgradeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/Upgrades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeImpacts": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.UpgradeImpact' resource.", "operationId": "CreateFirmwareUpgradeImpact", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.UpgradeImpact", "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Upgrade chassis firmware", "PRIVSET.Upgrade domain firmware", "PRIVSET.Upgrade server firmware", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.UpgradeImpact' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeImpact" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UpgradeImpact' resource was created as requested. The 'firmware.UpgradeImpact' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeImpact" } } }, "links": { "GetFirmwareUpgradeImpactByMoid": { "operationId": "GetFirmwareUpgradeImpactByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeImpacts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeImpactStatuses": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UpgradeImpactStatus' resource.", "operationId": "GetFirmwareUpgradeImpactStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.UpgradeImpactStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.UpgradeImpactStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeImpactStatuses/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UpgradeImpactStatus' resource.", "operationId": "GetFirmwareUpgradeImpactStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.UpgradeImpactStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.UpgradeImpactStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareUpgradeImpactStatusByMoid": { "operationId": "GetFirmwareUpgradeImpactStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeImpactStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeStatuses": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UpgradeStatus' resource.", "operationId": "GetFirmwareUpgradeStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.UpgradeStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'firmware.UpgradeStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeStatuses/{Moid}": { "get": { "tags": [ "firmware" ], "summary": "Read a 'firmware.UpgradeStatus' resource.", "operationId": "GetFirmwareUpgradeStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.firmware.UpgradeStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'firmware.UpgradeStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetFirmwareUpgradeStatusByMoid": { "operationId": "GetFirmwareUpgradeStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/firmware/UpgradeValidities": { "post": { "tags": [ "firmware" ], "summary": "Create a 'firmware.UpgradeValidity' resource.", "operationId": "CreateFirmwareUpgradeValidity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.firmware.UpgradeValidity", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'firmware.UpgradeValidity' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeValidity" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'firmware.UpgradeValidity' resource was created as requested. The 'firmware.UpgradeValidity' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firmware.UpgradeValidity" } } }, "links": { "GetFirmwareUpgradeValidityByMoid": { "operationId": "GetFirmwareUpgradeValidityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/firmware/UpgradeValidities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/graphics/Cards": { "get": { "tags": [ "graphics" ], "summary": "Read a 'graphics.Card' resource.", "operationId": "GetGraphicsCardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.graphics.Card", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'graphics.Card' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/graphics/Cards/{Moid}": { "get": { "tags": [ "graphics" ], "summary": "Read a 'graphics.Card' resource.", "operationId": "GetGraphicsCardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.graphics.Card", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'graphics.Card' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetGraphicsCardByMoid": { "operationId": "GetGraphicsCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "graphics" ], "summary": "Update a 'graphics.Card' resource.", "operationId": "UpdateGraphicsCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.graphics.Card" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'graphics.Card' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Card' resource was modified as requested. The 'graphics.Card' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card" } } }, "links": { "GetGraphicsCardByMoid": { "operationId": "GetGraphicsCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "graphics" ], "summary": "Update a 'graphics.Card' resource.", "operationId": "PatchGraphicsCard", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.graphics.Card" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'graphics.Card' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Card' resource was patched as requested. The 'graphics.Card' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Card" } } }, "links": { "GetGraphicsCardByMoid": { "operationId": "GetGraphicsCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Cards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/graphics/Controllers": { "get": { "tags": [ "graphics" ], "summary": "Read a 'graphics.Controller' resource.", "operationId": "GetGraphicsControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.graphics.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'graphics.Controller' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/graphics/Controllers/{Moid}": { "get": { "tags": [ "graphics" ], "summary": "Read a 'graphics.Controller' resource.", "operationId": "GetGraphicsControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.graphics.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'graphics.Controller' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetGraphicsControllerByMoid": { "operationId": "GetGraphicsControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "graphics" ], "summary": "Update a 'graphics.Controller' resource.", "operationId": "UpdateGraphicsController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.graphics.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'graphics.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Controller' resource was modified as requested. The 'graphics.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller" } } }, "links": { "GetGraphicsControllerByMoid": { "operationId": "GetGraphicsControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "graphics" ], "summary": "Update a 'graphics.Controller' resource.", "operationId": "PatchGraphicsController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.graphics.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'graphics.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'graphics.Controller' resource was patched as requested. The 'graphics.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/graphics.Controller" } } }, "links": { "GetGraphicsControllerByMoid": { "operationId": "GetGraphicsControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/graphics/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/DeviceInfos": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.DeviceInfo' resource.", "operationId": "GetInventoryDeviceInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.inventory.DeviceInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'inventory.DeviceInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.DeviceInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/DeviceInfos/{Moid}": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.DeviceInfo' resource.", "operationId": "GetInventoryDeviceInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.inventory.DeviceInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'inventory.DeviceInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.DeviceInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetInventoryDeviceInfoByMoid": { "operationId": "GetInventoryDeviceInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/DeviceInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/DnMoBindings": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.DnMoBinding' resource.", "operationId": "GetInventoryDnMoBindingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.inventory.DnMoBinding" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'inventory.DnMoBinding' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.DnMoBinding.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/DnMoBindings/{Moid}": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.DnMoBinding' resource.", "operationId": "GetInventoryDnMoBindingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.inventory.DnMoBinding" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'inventory.DnMoBinding' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.DnMoBinding" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetInventoryDnMoBindingByMoid": { "operationId": "GetInventoryDnMoBindingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/DnMoBindings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/GenericInventories": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.GenericInventory' resource.", "operationId": "GetInventoryGenericInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.inventory.GenericInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'inventory.GenericInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/GenericInventories/{Moid}": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.GenericInventory' resource.", "operationId": "GetInventoryGenericInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.inventory.GenericInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'inventory.GenericInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetInventoryGenericInventoryByMoid": { "operationId": "GetInventoryGenericInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "inventory" ], "summary": "Update a 'inventory.GenericInventory' resource.", "operationId": "UpdateInventoryGenericInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.inventory.GenericInventory" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'inventory.GenericInventory' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventory' resource was modified as requested. The 'inventory.GenericInventory' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory" } } }, "links": { "GetInventoryGenericInventoryByMoid": { "operationId": "GetInventoryGenericInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "inventory" ], "summary": "Update a 'inventory.GenericInventory' resource.", "operationId": "PatchInventoryGenericInventory", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.inventory.GenericInventory" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'inventory.GenericInventory' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventory' resource was patched as requested. The 'inventory.GenericInventory' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventory" } } }, "links": { "GetInventoryGenericInventoryByMoid": { "operationId": "GetInventoryGenericInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/GenericInventoryHolders": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.GenericInventoryHolder' resource.", "operationId": "GetInventoryGenericInventoryHolderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.inventory.GenericInventoryHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'inventory.GenericInventoryHolder' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/GenericInventoryHolders/{Moid}": { "get": { "tags": [ "inventory" ], "summary": "Read a 'inventory.GenericInventoryHolder' resource.", "operationId": "GetInventoryGenericInventoryHolderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.inventory.GenericInventoryHolder", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'inventory.GenericInventoryHolder' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetInventoryGenericInventoryHolderByMoid": { "operationId": "GetInventoryGenericInventoryHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "inventory" ], "summary": "Update a 'inventory.GenericInventoryHolder' resource.", "operationId": "UpdateInventoryGenericInventoryHolder", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.inventory.GenericInventoryHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'inventory.GenericInventoryHolder' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventoryHolder' resource was modified as requested. The 'inventory.GenericInventoryHolder' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } } }, "links": { "GetInventoryGenericInventoryHolderByMoid": { "operationId": "GetInventoryGenericInventoryHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "inventory" ], "summary": "Update a 'inventory.GenericInventoryHolder' resource.", "operationId": "PatchInventoryGenericInventoryHolder", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.inventory.GenericInventoryHolder" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'inventory.GenericInventoryHolder' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.GenericInventoryHolder' resource was patched as requested. The 'inventory.GenericInventoryHolder' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } } }, "links": { "GetInventoryGenericInventoryHolderByMoid": { "operationId": "GetInventoryGenericInventoryHolderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/GenericInventoryHolders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/inventory/Requests": { "post": { "tags": [ "inventory" ], "summary": "Create a 'inventory.Request' resource.", "operationId": "CreateInventoryRequest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.inventory.Request" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'inventory.Request' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.Request" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'inventory.Request' resource was created as requested. The 'inventory.Request' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inventory.Request" } } }, "links": { "GetInventoryRequestByMoid": { "operationId": "GetInventoryRequestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/inventory/Requests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ipmioverlan/Policies": { "post": { "tags": [ "ipmioverlan" ], "summary": "Create a 'ipmioverlan.Policy' resource.", "operationId": "CreateIpmioverlanPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.ipmioverlan.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit IPMI over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'ipmioverlan.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ipmioverlan.Policy' resource was created as requested. The 'ipmioverlan.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } } }, "links": { "GetIpmioverlanPolicyByMoid": { "operationId": "GetIpmioverlanPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "ipmioverlan" ], "summary": "Read a 'ipmioverlan.Policy' resource.", "operationId": "GetIpmioverlanPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IPMI over LAN policies", "PRIVSET.View Server Profiles", "READ.ipmioverlan.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ipmioverlan.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ipmioverlan/Policies/{Moid}": { "get": { "tags": [ "ipmioverlan" ], "summary": "Read a 'ipmioverlan.Policy' resource.", "operationId": "GetIpmioverlanPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IPMI over LAN policies", "PRIVSET.View Server Profiles", "READ.ipmioverlan.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ipmioverlan.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIpmioverlanPolicyByMoid": { "operationId": "GetIpmioverlanPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ipmioverlan" ], "summary": "Update a 'ipmioverlan.Policy' resource.", "operationId": "UpdateIpmioverlanPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IPMI over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.ipmioverlan.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ipmioverlan.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ipmioverlan.Policy' resource was modified as requested. The 'ipmioverlan.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } } }, "links": { "GetIpmioverlanPolicyByMoid": { "operationId": "GetIpmioverlanPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ipmioverlan" ], "summary": "Update a 'ipmioverlan.Policy' resource.", "operationId": "PatchIpmioverlanPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IPMI over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.ipmioverlan.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ipmioverlan.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ipmioverlan.Policy' resource was patched as requested. The 'ipmioverlan.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.Policy" } } }, "links": { "GetIpmioverlanPolicyByMoid": { "operationId": "GetIpmioverlanPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ipmioverlan" ], "summary": "Delete a 'ipmioverlan.Policy' resource.", "operationId": "DeleteIpmioverlanPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ipmioverlan.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete IPMI over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ipmioverlan/PolicyInventories": { "get": { "tags": [ "ipmioverlan" ], "summary": "Read a 'ipmioverlan.PolicyInventory' resource.", "operationId": "GetIpmioverlanPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IPMI over LAN policies", "PRIVSET.View Server Profiles", "READ.ipmioverlan.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ipmioverlan.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ipmioverlan/PolicyInventories/{Moid}": { "get": { "tags": [ "ipmioverlan" ], "summary": "Read a 'ipmioverlan.PolicyInventory' resource.", "operationId": "GetIpmioverlanPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IPMI over LAN policies", "PRIVSET.View Server Profiles", "READ.ipmioverlan.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ipmioverlan.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ipmioverlan.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIpmioverlanPolicyInventoryByMoid": { "operationId": "GetIpmioverlanPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ipmioverlan/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/BlockLeases": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.BlockLease' resource.", "operationId": "GetIppoolBlockLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.BlockLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.BlockLease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.BlockLease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/BlockLeases/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.BlockLease' resource.", "operationId": "GetIppoolBlockLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.BlockLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.BlockLease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.BlockLease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolBlockLeaseByMoid": { "operationId": "GetIppoolBlockLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/BlockLeases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/IpLeases": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.IpLease' resource.", "operationId": "GetIppoolIpLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.IpLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.IpLease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.IpLease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/IpLeases/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.IpLease' resource.", "operationId": "GetIppoolIpLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.IpLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.IpLease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.IpLease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolIpLeaseByMoid": { "operationId": "GetIppoolIpLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/IpLeases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ippool" ], "summary": "Delete a 'ippool.IpLease' resource.", "operationId": "DeleteIppoolIpLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ippool.IpLease", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Pools": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Pool' resource.", "operationId": "GetIppoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.Pool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ippool" ], "summary": "Create a 'ippool.Pool' resource.", "operationId": "CreateIppoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.ippool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create IP pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'ippool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Pool' resource was created as requested. The 'ippool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } } }, "links": { "GetIppoolPoolByMoid": { "operationId": "GetIppoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Pools/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Pool' resource.", "operationId": "GetIppoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.Pool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolPoolByMoid": { "operationId": "GetIppoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ippool" ], "summary": "Update a 'ippool.Pool' resource.", "operationId": "UpdateIppoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IP pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.ippool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ippool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Pool' resource was modified as requested. The 'ippool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } } }, "links": { "GetIppoolPoolByMoid": { "operationId": "GetIppoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ippool" ], "summary": "Update a 'ippool.Pool' resource.", "operationId": "PatchIppoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IP pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.ippool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ippool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Pool' resource was patched as requested. The 'ippool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Pool" } } }, "links": { "GetIppoolPoolByMoid": { "operationId": "GetIppoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ippool" ], "summary": "Delete a 'ippool.Pool' resource.", "operationId": "DeleteIppoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ippool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete IP pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/PoolMembers": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.PoolMember' resource.", "operationId": "GetIppoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.PoolMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/PoolMembers/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.PoolMember' resource.", "operationId": "GetIppoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.PoolMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.PoolMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolPoolMemberByMoid": { "operationId": "GetIppoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/PoolMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Reservations": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Reservation' resource.", "operationId": "GetIppoolReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create IP pool address reservations", "PRIVSET.Delete IP pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ippool" ], "summary": "Create a 'ippool.Reservation' resource.", "operationId": "CreateIppoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.ippool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Create IP pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'ippool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Reservation' resource was created as requested. The 'ippool.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } } }, "links": { "GetIppoolReservationByMoid": { "operationId": "GetIppoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Reservations/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Reservation' resource.", "operationId": "GetIppoolReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create IP pool address reservations", "PRIVSET.Delete IP pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolReservationByMoid": { "operationId": "GetIppoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ippool" ], "summary": "Delete a 'ippool.Reservation' resource.", "operationId": "DeleteIppoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ippool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Delete IP pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ippool" ], "summary": "Update a 'ippool.Reservation' resource.", "operationId": "UpdateIppoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.ippool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ippool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Reservation' resource was modified as requested. The 'ippool.Reservation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } } }, "links": { "GetIppoolReservationByMoid": { "operationId": "GetIppoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ippool" ], "summary": "Update a 'ippool.Reservation' resource.", "operationId": "PatchIppoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.ippool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ippool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ippool.Reservation' resource was patched as requested. The 'ippool.Reservation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Reservation" } } }, "links": { "GetIppoolReservationByMoid": { "operationId": "GetIppoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/ShadowBlocks": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.ShadowBlock' resource.", "operationId": "GetIppoolShadowBlockList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.ShadowBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.ShadowBlock' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.ShadowBlock.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/ShadowBlocks/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.ShadowBlock' resource.", "operationId": "GetIppoolShadowBlockByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.ShadowBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.ShadowBlock' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.ShadowBlock" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolShadowBlockByMoid": { "operationId": "GetIppoolShadowBlockByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/ShadowBlocks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/ShadowPools": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.ShadowPool' resource.", "operationId": "GetIppoolShadowPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.ShadowPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.ShadowPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.ShadowPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/ShadowPools/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.ShadowPool' resource.", "operationId": "GetIppoolShadowPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.ShadowPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.ShadowPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.ShadowPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolShadowPoolByMoid": { "operationId": "GetIppoolShadowPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/ShadowPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Universes": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Universe' resource.", "operationId": "GetIppoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ippool.Universe' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ippool/Universes/{Moid}": { "get": { "tags": [ "ippool" ], "summary": "Read a 'ippool.Universe' resource.", "operationId": "GetIppoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.ippool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ippool.Universe' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ippool.Universe" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIppoolUniverseByMoid": { "operationId": "GetIppoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ippool/Universes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Blocks": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Block' resource.", "operationId": "GetIqnpoolBlockList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Block", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.Block' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Block.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Blocks/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Block' resource.", "operationId": "GetIqnpoolBlockByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Block", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.Block' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Block" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolBlockByMoid": { "operationId": "GetIqnpoolBlockByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Blocks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Leases": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Lease' resource.", "operationId": "GetIqnpoolLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.Lease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Lease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Leases/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Lease' resource.", "operationId": "GetIqnpoolLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.Lease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Lease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolLeaseByMoid": { "operationId": "GetIqnpoolLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Leases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iqnpool" ], "summary": "Delete a 'iqnpool.Lease' resource.", "operationId": "DeleteIqnpoolLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iqnpool.Lease", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Pools": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Pool' resource.", "operationId": "GetIqnpoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.Pool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iqnpool" ], "summary": "Create a 'iqnpool.Pool' resource.", "operationId": "CreateIqnpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iqnpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create IQN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iqnpool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iqnpool.Pool' resource was created as requested. The 'iqnpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } } }, "links": { "GetIqnpoolPoolByMoid": { "operationId": "GetIqnpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Pools/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Pool' resource.", "operationId": "GetIqnpoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.Pool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolPoolByMoid": { "operationId": "GetIqnpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iqnpool" ], "summary": "Update a 'iqnpool.Pool' resource.", "operationId": "UpdateIqnpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IQN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.iqnpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iqnpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iqnpool.Pool' resource was modified as requested. The 'iqnpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } } }, "links": { "GetIqnpoolPoolByMoid": { "operationId": "GetIqnpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "iqnpool" ], "summary": "Update a 'iqnpool.Pool' resource.", "operationId": "PatchIqnpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit IQN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.iqnpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'iqnpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iqnpool.Pool' resource was patched as requested. The 'iqnpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Pool" } } }, "links": { "GetIqnpoolPoolByMoid": { "operationId": "GetIqnpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iqnpool" ], "summary": "Delete a 'iqnpool.Pool' resource.", "operationId": "DeleteIqnpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iqnpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete IQN pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/PoolMembers": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.PoolMember' resource.", "operationId": "GetIqnpoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.PoolMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/PoolMembers/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.PoolMember' resource.", "operationId": "GetIqnpoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.PoolMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.PoolMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolPoolMemberByMoid": { "operationId": "GetIqnpoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/PoolMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Reservations": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Reservation' resource.", "operationId": "GetIqnpoolReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create IQN pool address reservations", "PRIVSET.Delete IQN pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "iqnpool" ], "summary": "Create a 'iqnpool.Reservation' resource.", "operationId": "CreateIqnpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.iqnpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Create IQN pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'iqnpool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'iqnpool.Reservation' resource was created as requested. The 'iqnpool.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Reservation" } } }, "links": { "GetIqnpoolReservationByMoid": { "operationId": "GetIqnpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Reservations/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Reservation' resource.", "operationId": "GetIqnpoolReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create IQN pool address reservations", "PRIVSET.Delete IQN pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolReservationByMoid": { "operationId": "GetIqnpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "iqnpool" ], "summary": "Delete a 'iqnpool.Reservation' resource.", "operationId": "DeleteIqnpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.iqnpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Delete IQN pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Universes": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Universe' resource.", "operationId": "GetIqnpoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'iqnpool.Universe' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/iqnpool/Universes/{Moid}": { "get": { "tags": [ "iqnpool" ], "summary": "Read a 'iqnpool.Universe' resource.", "operationId": "GetIqnpoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IQN pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.iqnpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'iqnpool.Universe' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/iqnpool.Universe" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetIqnpoolUniverseByMoid": { "operationId": "GetIqnpoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iqnpool/Universes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Policies": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Policy' resource.", "operationId": "GetKvmPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Server Profiles", "READ.kvm.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'kvm.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "kvm" ], "summary": "Create a 'kvm.Policy' resource.", "operationId": "CreateKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.kvm.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Virtual KVM policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'kvm.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Policy' resource was created as requested. The 'kvm.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } } }, "links": { "GetKvmPolicyByMoid": { "operationId": "GetKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Policies/{Moid}": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Policy' resource.", "operationId": "GetKvmPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Server Profiles", "READ.kvm.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'kvm.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetKvmPolicyByMoid": { "operationId": "GetKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "kvm" ], "summary": "Update a 'kvm.Policy' resource.", "operationId": "UpdateKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Virtual KVM policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.kvm.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Policy' resource was modified as requested. The 'kvm.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } } }, "links": { "GetKvmPolicyByMoid": { "operationId": "GetKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "kvm" ], "summary": "Update a 'kvm.Policy' resource.", "operationId": "PatchKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Virtual KVM policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.kvm.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Policy' resource was patched as requested. The 'kvm.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Policy" } } }, "links": { "GetKvmPolicyByMoid": { "operationId": "GetKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "kvm" ], "summary": "Delete a 'kvm.Policy' resource.", "operationId": "DeleteKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.kvm.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Virtual KVM policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/PolicyInventories": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.PolicyInventory' resource.", "operationId": "GetKvmPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Server Profiles", "READ.kvm.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'kvm.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/PolicyInventories/{Moid}": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.PolicyInventory' resource.", "operationId": "GetKvmPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Server Profiles", "READ.kvm.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'kvm.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetKvmPolicyInventoryByMoid": { "operationId": "GetKvmPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Sessions": { "post": { "tags": [ "kvm" ], "summary": "Create a 'kvm.Session' resource.", "operationId": "CreateKvmSession", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.kvm.Session", "PRIVSET.Account Administrator", "PRIVSET.Launch vKVM", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'kvm.Session' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Session' resource was created as requested. The 'kvm.Session' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } } }, "links": { "GetKvmSessionByMoid": { "operationId": "GetKvmSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Sessions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Session' resource.", "operationId": "GetKvmSessionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Launch vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.View Servers", "PRIVSET.View sessions", "READ.kvm.Session", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'kvm.Session' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Sessions/{Moid}": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Session' resource.", "operationId": "GetKvmSessionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Launch vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.View Servers", "PRIVSET.View sessions", "READ.kvm.Session", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'kvm.Session' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetKvmSessionByMoid": { "operationId": "GetKvmSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Sessions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "kvm" ], "summary": "Update a 'kvm.Session' resource.", "operationId": "UpdateKvmSession", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Launch vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.Terminate sessions", "ROLE.Account Administrator", "UPDATE.kvm.Session" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.Session' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Session' resource was modified as requested. The 'kvm.Session' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } } }, "links": { "GetKvmSessionByMoid": { "operationId": "GetKvmSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Sessions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "kvm" ], "summary": "Update a 'kvm.Session' resource.", "operationId": "PatchKvmSession", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Launch vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.Terminate sessions", "ROLE.Account Administrator", "UPDATE.kvm.Session" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.Session' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Session' resource was patched as requested. The 'kvm.Session' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Session" } } }, "links": { "GetKvmSessionByMoid": { "operationId": "GetKvmSessionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Sessions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Tunnels": { "post": { "tags": [ "kvm" ], "summary": "Create a 'kvm.Tunnel' resource.", "operationId": "CreateKvmTunnel", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.kvm.Tunnel", "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'kvm.Tunnel' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Tunnel" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.Tunnel' resource was created as requested. The 'kvm.Tunnel' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Tunnel" } } }, "links": { "GetKvmTunnelByMoid": { "operationId": "GetKvmTunnelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Tunnels/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Tunnel' resource.", "operationId": "GetKvmTunnelList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.View Servers", "READ.kvm.Tunnel", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'kvm.Tunnel' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Tunnel.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/Tunnels/{Moid}": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.Tunnel' resource.", "operationId": "GetKvmTunnelByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Launch vKVM", "PRIVSET.Manage Servers", "PRIVSET.Manage Sessions", "PRIVSET.View Servers", "READ.kvm.Tunnel", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'kvm.Tunnel' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.Tunnel" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetKvmTunnelByMoid": { "operationId": "GetKvmTunnelByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/Tunnels/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/TunneledKvmPolicies": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.TunneledKvmPolicy' resource.", "operationId": "GetKvmTunneledKvmPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tunneled vKVM configurations", "PRIVSET.Allow/disallow tunneled vKVM launches", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Servers", "READ.kvm.TunneledKvmPolicy", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'kvm.TunneledKvmPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "kvm" ], "summary": "Create a 'kvm.TunneledKvmPolicy' resource.", "operationId": "CreateKvmTunneledKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.kvm.TunneledKvmPolicy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'kvm.TunneledKvmPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.TunneledKvmPolicy' resource was created as requested. The 'kvm.TunneledKvmPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } } }, "links": { "GetKvmTunneledKvmPolicyByMoid": { "operationId": "GetKvmTunneledKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/TunneledKvmPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/kvm/TunneledKvmPolicies/{Moid}": { "get": { "tags": [ "kvm" ], "summary": "Read a 'kvm.TunneledKvmPolicy' resource.", "operationId": "GetKvmTunneledKvmPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Allow/disallow tunneled vKVM configurations", "PRIVSET.Allow/disallow tunneled vKVM launches", "PRIVSET.Launch tunneled vKVM sessions", "PRIVSET.Manage Servers", "PRIVSET.Read-only Virtual KVM policies", "PRIVSET.View Servers", "READ.kvm.TunneledKvmPolicy", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'kvm.TunneledKvmPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetKvmTunneledKvmPolicyByMoid": { "operationId": "GetKvmTunneledKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/TunneledKvmPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "kvm" ], "summary": "Update a 'kvm.TunneledKvmPolicy' resource.", "operationId": "UpdateKvmTunneledKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.kvm.TunneledKvmPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.TunneledKvmPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.TunneledKvmPolicy' resource was modified as requested. The 'kvm.TunneledKvmPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } } }, "links": { "GetKvmTunneledKvmPolicyByMoid": { "operationId": "GetKvmTunneledKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/TunneledKvmPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "kvm" ], "summary": "Update a 'kvm.TunneledKvmPolicy' resource.", "operationId": "PatchKvmTunneledKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.kvm.TunneledKvmPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'kvm.TunneledKvmPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'kvm.TunneledKvmPolicy' resource was patched as requested. The 'kvm.TunneledKvmPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" } } }, "links": { "GetKvmTunneledKvmPolicyByMoid": { "operationId": "GetKvmTunneledKvmPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/kvm/TunneledKvmPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "kvm" ], "summary": "Delete a 'kvm.TunneledKvmPolicy' resource.", "operationId": "DeleteKvmTunneledKvmPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.kvm.TunneledKvmPolicy", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ls/ServiceProfiles": { "get": { "tags": [ "ls" ], "summary": "Read a 'ls.ServiceProfile' resource.", "operationId": "GetLsServiceProfileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.ls.ServiceProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ls.ServiceProfile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ls/ServiceProfiles/{Moid}": { "get": { "tags": [ "ls" ], "summary": "Read a 'ls.ServiceProfile' resource.", "operationId": "GetLsServiceProfileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.ls.ServiceProfile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ls.ServiceProfile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetLsServiceProfileByMoid": { "operationId": "GetLsServiceProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ls" ], "summary": "Update a 'ls.ServiceProfile' resource.", "operationId": "UpdateLsServiceProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.ls.ServiceProfile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ls.ServiceProfile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ls.ServiceProfile' resource was modified as requested. The 'ls.ServiceProfile' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile" } } }, "links": { "GetLsServiceProfileByMoid": { "operationId": "GetLsServiceProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ls" ], "summary": "Update a 'ls.ServiceProfile' resource.", "operationId": "PatchLsServiceProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.ls.ServiceProfile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ls.ServiceProfile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ls.ServiceProfile' resource was patched as requested. The 'ls.ServiceProfile' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ls.ServiceProfile" } } }, "links": { "GetLsServiceProfileByMoid": { "operationId": "GetLsServiceProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ls/ServiceProfiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/IdBlocks": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.IdBlock' resource.", "operationId": "GetMacpoolIdBlockList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.IdBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.IdBlock' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.IdBlock.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/IdBlocks/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.IdBlock' resource.", "operationId": "GetMacpoolIdBlockByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.IdBlock", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.IdBlock' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.IdBlock" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolIdBlockByMoid": { "operationId": "GetMacpoolIdBlockByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/IdBlocks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Leases": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Lease' resource.", "operationId": "GetMacpoolLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.Lease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Lease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Leases/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Lease' resource.", "operationId": "GetMacpoolLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Lease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.Lease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Lease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolLeaseByMoid": { "operationId": "GetMacpoolLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Leases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "macpool" ], "summary": "Delete a 'macpool.Lease' resource.", "operationId": "DeleteMacpoolLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.macpool.Lease", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Pools": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Pool' resource.", "operationId": "GetMacpoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.Pool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "macpool" ], "summary": "Create a 'macpool.Pool' resource.", "operationId": "CreateMacpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.macpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create MAC pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'macpool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Pool' resource was created as requested. The 'macpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } } }, "links": { "GetMacpoolPoolByMoid": { "operationId": "GetMacpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Pools/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Pool' resource.", "operationId": "GetMacpoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.Pool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolPoolByMoid": { "operationId": "GetMacpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "macpool" ], "summary": "Update a 'macpool.Pool' resource.", "operationId": "UpdateMacpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit MAC pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.macpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'macpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Pool' resource was modified as requested. The 'macpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } } }, "links": { "GetMacpoolPoolByMoid": { "operationId": "GetMacpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "macpool" ], "summary": "Update a 'macpool.Pool' resource.", "operationId": "PatchMacpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit MAC pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.macpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'macpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Pool' resource was patched as requested. The 'macpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Pool" } } }, "links": { "GetMacpoolPoolByMoid": { "operationId": "GetMacpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "macpool" ], "summary": "Delete a 'macpool.Pool' resource.", "operationId": "DeleteMacpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.macpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete MAC pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/PoolMembers": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.PoolMember' resource.", "operationId": "GetMacpoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.PoolMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/PoolMembers/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.PoolMember' resource.", "operationId": "GetMacpoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.PoolMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.PoolMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolPoolMemberByMoid": { "operationId": "GetMacpoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/PoolMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Reservations": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Reservation' resource.", "operationId": "GetMacpoolReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create MAC pool address reservations", "PRIVSET.Delete MAC pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "macpool" ], "summary": "Create a 'macpool.Reservation' resource.", "operationId": "CreateMacpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.macpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Create MAC pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'macpool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Reservation' resource was created as requested. The 'macpool.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } } }, "links": { "GetMacpoolReservationByMoid": { "operationId": "GetMacpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Reservations/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Reservation' resource.", "operationId": "GetMacpoolReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create MAC pool address reservations", "PRIVSET.Delete MAC pool address reservations", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolReservationByMoid": { "operationId": "GetMacpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "macpool" ], "summary": "Delete a 'macpool.Reservation' resource.", "operationId": "DeleteMacpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.macpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Delete MAC pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "macpool" ], "summary": "Update a 'macpool.Reservation' resource.", "operationId": "UpdateMacpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.macpool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'macpool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Reservation' resource was modified as requested. The 'macpool.Reservation' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } } }, "links": { "GetMacpoolReservationByMoid": { "operationId": "GetMacpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "macpool" ], "summary": "Update a 'macpool.Reservation' resource.", "operationId": "PatchMacpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.macpool.Reservation" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'macpool.Reservation' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'macpool.Reservation' resource was patched as requested. The 'macpool.Reservation' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Reservation" } } }, "links": { "GetMacpoolReservationByMoid": { "operationId": "GetMacpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Universes": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Universe' resource.", "operationId": "GetMacpoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'macpool.Universe' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/macpool/Universes/{Moid}": { "get": { "tags": [ "macpool" ], "summary": "Read a 'macpool.Universe' resource.", "operationId": "GetMacpoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only MAC pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.macpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'macpool.Universe' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/macpool.Universe" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMacpoolUniverseByMoid": { "operationId": "GetMacpoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/macpool/Universes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Controllers": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Controller' resource.", "operationId": "GetManagementControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.management.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'management.Controller' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Controllers/{Moid}": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Controller' resource.", "operationId": "GetManagementControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.management.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'management.Controller' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetManagementControllerByMoid": { "operationId": "GetManagementControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "management" ], "summary": "Update a 'management.Controller' resource.", "operationId": "UpdateManagementController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.management.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Controller' resource was modified as requested. The 'management.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller" } } }, "links": { "GetManagementControllerByMoid": { "operationId": "GetManagementControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "management" ], "summary": "Update a 'management.Controller' resource.", "operationId": "PatchManagementController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.management.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Controller' resource was patched as requested. The 'management.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Controller" } } }, "links": { "GetManagementControllerByMoid": { "operationId": "GetManagementControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Entities": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Entity' resource.", "operationId": "GetManagementEntityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.management.Entity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'management.Entity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Entities/{Moid}": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Entity' resource.", "operationId": "GetManagementEntityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.View Fabric Interconnects", "READ.management.Entity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'management.Entity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetManagementEntityByMoid": { "operationId": "GetManagementEntityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "management" ], "summary": "Update a 'management.Entity' resource.", "operationId": "UpdateManagementEntity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.management.Entity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Entity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Entity' resource was modified as requested. The 'management.Entity' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity" } } }, "links": { "GetManagementEntityByMoid": { "operationId": "GetManagementEntityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "management" ], "summary": "Update a 'management.Entity' resource.", "operationId": "PatchManagementEntity", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "ROLE.Account Administrator", "UPDATE.management.Entity" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Entity' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Entity' resource was patched as requested. The 'management.Entity' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Entity" } } }, "links": { "GetManagementEntityByMoid": { "operationId": "GetManagementEntityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Entities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Interfaces": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Interface' resource.", "operationId": "GetManagementInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.management.Interface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'management.Interface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/management/Interfaces/{Moid}": { "get": { "tags": [ "management" ], "summary": "Read a 'management.Interface' resource.", "operationId": "GetManagementInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.management.Interface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'management.Interface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetManagementInterfaceByMoid": { "operationId": "GetManagementInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "management" ], "summary": "Update a 'management.Interface' resource.", "operationId": "UpdateManagementInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.management.Interface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Interface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Interface' resource was modified as requested. The 'management.Interface' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface" } } }, "links": { "GetManagementInterfaceByMoid": { "operationId": "GetManagementInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "management" ], "summary": "Update a 'management.Interface' resource.", "operationId": "PatchManagementInterface", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.management.Interface" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'management.Interface' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'management.Interface' resource was patched as requested. The 'management.Interface' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/management.Interface" } } }, "links": { "GetManagementInterfaceByMoid": { "operationId": "GetManagementInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/management/Interfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Arrays": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Array' resource.", "operationId": "GetMemoryArrayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.Array", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.Array' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Arrays/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Array' resource.", "operationId": "GetMemoryArrayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.Array", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.Array' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryArrayByMoid": { "operationId": "GetMemoryArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.Array' resource.", "operationId": "UpdateMemoryArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.Array" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Array' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Array' resource was modified as requested. The 'memory.Array' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array" } } }, "links": { "GetMemoryArrayByMoid": { "operationId": "GetMemoryArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.Array' resource.", "operationId": "PatchMemoryArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.Array" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Array' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Array' resource was patched as requested. The 'memory.Array' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Array" } } }, "links": { "GetMemoryArrayByMoid": { "operationId": "GetMemoryArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Arrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryConfigResults": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryConfigResult' resource.", "operationId": "GetMemoryPersistentMemoryConfigResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryConfigResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryConfigResults/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryConfigResult' resource.", "operationId": "GetMemoryPersistentMemoryConfigResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryConfigResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryConfigResult' resource.", "operationId": "UpdateMemoryPersistentMemoryConfigResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryConfigResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryConfigResult' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfigResult' resource was modified as requested. The 'memory.PersistentMemoryConfigResult' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } } }, "links": { "GetMemoryPersistentMemoryConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryConfigResult' resource.", "operationId": "PatchMemoryPersistentMemoryConfigResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryConfigResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryConfigResult' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfigResult' resource was patched as requested. The 'memory.PersistentMemoryConfigResult' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } } }, "links": { "GetMemoryPersistentMemoryConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryConfigurations": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryConfiguration' resource.", "operationId": "GetMemoryPersistentMemoryConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryConfigurations/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryConfiguration' resource.", "operationId": "GetMemoryPersistentMemoryConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryConfigurationByMoid": { "operationId": "GetMemoryPersistentMemoryConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryConfiguration' resource.", "operationId": "UpdateMemoryPersistentMemoryConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfiguration' resource was modified as requested. The 'memory.PersistentMemoryConfiguration' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } } }, "links": { "GetMemoryPersistentMemoryConfigurationByMoid": { "operationId": "GetMemoryPersistentMemoryConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryConfiguration' resource.", "operationId": "PatchMemoryPersistentMemoryConfiguration", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryConfiguration" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryConfiguration' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryConfiguration' resource was patched as requested. The 'memory.PersistentMemoryConfiguration' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } } }, "links": { "GetMemoryPersistentMemoryConfigurationByMoid": { "operationId": "GetMemoryPersistentMemoryConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryNamespaces": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryNamespace' resource.", "operationId": "GetMemoryPersistentMemoryNamespaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryNamespace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryNamespace' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryNamespaces/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryNamespace' resource.", "operationId": "GetMemoryPersistentMemoryNamespaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryNamespace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryNamespace' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryNamespaceByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryNamespace' resource.", "operationId": "UpdateMemoryPersistentMemoryNamespace", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryNamespace" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryNamespace' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespace' resource was modified as requested. The 'memory.PersistentMemoryNamespace' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } } }, "links": { "GetMemoryPersistentMemoryNamespaceByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryNamespace' resource.", "operationId": "PatchMemoryPersistentMemoryNamespace", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryNamespace" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryNamespace' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespace' resource was patched as requested. The 'memory.PersistentMemoryNamespace' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } } }, "links": { "GetMemoryPersistentMemoryNamespaceByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryNamespaceConfigResults": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "operationId": "GetMemoryPersistentMemoryNamespaceConfigResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryNamespaceConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryNamespaceConfigResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "operationId": "GetMemoryPersistentMemoryNamespaceConfigResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryNamespaceConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryNamespaceConfigResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryNamespaceConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "operationId": "UpdateMemoryPersistentMemoryNamespaceConfigResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryNamespaceConfigResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryNamespaceConfigResult' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespaceConfigResult' resource was modified as requested. The 'memory.PersistentMemoryNamespaceConfigResult' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } } }, "links": { "GetMemoryPersistentMemoryNamespaceConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "operationId": "PatchMemoryPersistentMemoryNamespaceConfigResult", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryNamespaceConfigResult" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryNamespaceConfigResult' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryNamespaceConfigResult' resource was patched as requested. The 'memory.PersistentMemoryNamespaceConfigResult' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } } }, "links": { "GetMemoryPersistentMemoryNamespaceConfigResultByMoid": { "operationId": "GetMemoryPersistentMemoryNamespaceConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryNamespaceConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryPolicies": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryPolicy' resource.", "operationId": "GetMemoryPersistentMemoryPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Persistent Memory policies", "PRIVSET.View Server Profiles", "READ.memory.PersistentMemoryPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Create a 'memory.PersistentMemoryPolicy' resource.", "operationId": "CreateMemoryPersistentMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.memory.PersistentMemoryPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Persistent Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was created as requested. The 'memory.PersistentMemoryPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } } }, "links": { "GetMemoryPersistentMemoryPolicyByMoid": { "operationId": "GetMemoryPersistentMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryPolicies/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryPolicy' resource.", "operationId": "GetMemoryPersistentMemoryPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Persistent Memory policies", "PRIVSET.View Server Profiles", "READ.memory.PersistentMemoryPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryPolicyByMoid": { "operationId": "GetMemoryPersistentMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryPolicy' resource.", "operationId": "UpdateMemoryPersistentMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Persistent Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was modified as requested. The 'memory.PersistentMemoryPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } } }, "links": { "GetMemoryPersistentMemoryPolicyByMoid": { "operationId": "GetMemoryPersistentMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryPolicy' resource.", "operationId": "PatchMemoryPersistentMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Persistent Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryPolicy' resource was patched as requested. The 'memory.PersistentMemoryPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" } } }, "links": { "GetMemoryPersistentMemoryPolicyByMoid": { "operationId": "GetMemoryPersistentMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "memory" ], "summary": "Delete a 'memory.PersistentMemoryPolicy' resource.", "operationId": "DeleteMemoryPersistentMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.memory.PersistentMemoryPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Persistent Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryRegions": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryRegion' resource.", "operationId": "GetMemoryPersistentMemoryRegionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryRegion", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryRegion' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryRegions/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryRegion' resource.", "operationId": "GetMemoryPersistentMemoryRegionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryRegion", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryRegion' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryRegionByMoid": { "operationId": "GetMemoryPersistentMemoryRegionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryRegion' resource.", "operationId": "UpdateMemoryPersistentMemoryRegion", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryRegion" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryRegion' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryRegion' resource was modified as requested. The 'memory.PersistentMemoryRegion' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } } }, "links": { "GetMemoryPersistentMemoryRegionByMoid": { "operationId": "GetMemoryPersistentMemoryRegionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryRegion' resource.", "operationId": "PatchMemoryPersistentMemoryRegion", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryRegion" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryRegion' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryRegion' resource was patched as requested. The 'memory.PersistentMemoryRegion' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } } }, "links": { "GetMemoryPersistentMemoryRegionByMoid": { "operationId": "GetMemoryPersistentMemoryRegionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryRegions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryUnits": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryUnit' resource.", "operationId": "GetMemoryPersistentMemoryUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PersistentMemoryUnit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PersistentMemoryUnits/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PersistentMemoryUnit' resource.", "operationId": "GetMemoryPersistentMemoryUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.PersistentMemoryUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PersistentMemoryUnit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPersistentMemoryUnitByMoid": { "operationId": "GetMemoryPersistentMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryUnit' resource.", "operationId": "UpdateMemoryPersistentMemoryUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryUnit' resource was modified as requested. The 'memory.PersistentMemoryUnit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } } }, "links": { "GetMemoryPersistentMemoryUnitByMoid": { "operationId": "GetMemoryPersistentMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.PersistentMemoryUnit' resource.", "operationId": "PatchMemoryPersistentMemoryUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.PersistentMemoryUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.PersistentMemoryUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.PersistentMemoryUnit' resource was patched as requested. The 'memory.PersistentMemoryUnit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } } }, "links": { "GetMemoryPersistentMemoryUnitByMoid": { "operationId": "GetMemoryPersistentMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PersistentMemoryUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Policies": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Policy' resource.", "operationId": "GetMemoryPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Memory policies", "PRIVSET.View Server Profiles", "READ.memory.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Create a 'memory.Policy' resource.", "operationId": "CreateMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.memory.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'memory.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Policy' resource was created as requested. The 'memory.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } } }, "links": { "GetMemoryPolicyByMoid": { "operationId": "GetMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Policies/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Policy' resource.", "operationId": "GetMemoryPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Memory policies", "PRIVSET.View Server Profiles", "READ.memory.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPolicyByMoid": { "operationId": "GetMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.Policy' resource.", "operationId": "UpdateMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.memory.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Policy' resource was modified as requested. The 'memory.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } } }, "links": { "GetMemoryPolicyByMoid": { "operationId": "GetMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.Policy' resource.", "operationId": "PatchMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.memory.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Policy' resource was patched as requested. The 'memory.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Policy" } } }, "links": { "GetMemoryPolicyByMoid": { "operationId": "GetMemoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "memory" ], "summary": "Delete a 'memory.Policy' resource.", "operationId": "DeleteMemoryPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.memory.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Memory policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PolicyInventories": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PolicyInventory' resource.", "operationId": "GetMemoryPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Memory policies", "PRIVSET.View Server Profiles", "READ.memory.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/PolicyInventories/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.PolicyInventory' resource.", "operationId": "GetMemoryPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Memory policies", "PRIVSET.View Server Profiles", "READ.memory.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryPolicyInventoryByMoid": { "operationId": "GetMemoryPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Units": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Unit' resource.", "operationId": "GetMemoryUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'memory.Unit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/memory/Units/{Moid}": { "get": { "tags": [ "memory" ], "summary": "Read a 'memory.Unit' resource.", "operationId": "GetMemoryUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.memory.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'memory.Unit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetMemoryUnitByMoid": { "operationId": "GetMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "memory" ], "summary": "Update a 'memory.Unit' resource.", "operationId": "UpdateMemoryUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Unit' resource was modified as requested. The 'memory.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit" } } }, "links": { "GetMemoryUnitByMoid": { "operationId": "GetMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "memory" ], "summary": "Update a 'memory.Unit' resource.", "operationId": "PatchMemoryUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.memory.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'memory.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'memory.Unit' resource was patched as requested. The 'memory.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/memory.Unit" } } }, "links": { "GetMemoryUnitByMoid": { "operationId": "GetMemoryUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/memory/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/networkconfig/Policies": { "post": { "tags": [ "networkconfig" ], "summary": "Create a 'networkconfig.Policy' resource.", "operationId": "CreateNetworkconfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.networkconfig.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Network Connectivity policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'networkconfig.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'networkconfig.Policy' resource was created as requested. The 'networkconfig.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } } }, "links": { "GetNetworkconfigPolicyByMoid": { "operationId": "GetNetworkconfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "networkconfig" ], "summary": "Read a 'networkconfig.Policy' resource.", "operationId": "GetNetworkconfigPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Network Connectivity policies", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.networkconfig.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'networkconfig.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/networkconfig/Policies/{Moid}": { "get": { "tags": [ "networkconfig" ], "summary": "Read a 'networkconfig.Policy' resource.", "operationId": "GetNetworkconfigPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Network Connectivity policies", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.networkconfig.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'networkconfig.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNetworkconfigPolicyByMoid": { "operationId": "GetNetworkconfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "networkconfig" ], "summary": "Update a 'networkconfig.Policy' resource.", "operationId": "UpdateNetworkconfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure DNS settings", "PRIVSET.Edit Network Connectivity policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.networkconfig.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'networkconfig.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'networkconfig.Policy' resource was modified as requested. The 'networkconfig.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } } }, "links": { "GetNetworkconfigPolicyByMoid": { "operationId": "GetNetworkconfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "networkconfig" ], "summary": "Update a 'networkconfig.Policy' resource.", "operationId": "PatchNetworkconfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure DNS settings", "PRIVSET.Edit Network Connectivity policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.networkconfig.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'networkconfig.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'networkconfig.Policy' resource was patched as requested. The 'networkconfig.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.Policy" } } }, "links": { "GetNetworkconfigPolicyByMoid": { "operationId": "GetNetworkconfigPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "networkconfig" ], "summary": "Delete a 'networkconfig.Policy' resource.", "operationId": "DeleteNetworkconfigPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.networkconfig.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Network Connectivity policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/networkconfig/PolicyInventories": { "get": { "tags": [ "networkconfig" ], "summary": "Read a 'networkconfig.PolicyInventory' resource.", "operationId": "GetNetworkconfigPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Network Connectivity policies", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.networkconfig.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'networkconfig.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/networkconfig/PolicyInventories/{Moid}": { "get": { "tags": [ "networkconfig" ], "summary": "Read a 'networkconfig.PolicyInventory' resource.", "operationId": "GetNetworkconfigPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Network Connectivity policies", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.networkconfig.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'networkconfig.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/networkconfig.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNetworkconfigPolicyInventoryByMoid": { "operationId": "GetNetworkconfigPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/networkconfig/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/NtpServers": { "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.NtpServer' resource.", "operationId": "GetNtpNtpServerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "READ.ntp.NtpServer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ntp.NtpServer' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.NtpServer.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/NtpServers/{Moid}": { "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.NtpServer' resource.", "operationId": "GetNtpNtpServerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "READ.ntp.NtpServer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ntp.NtpServer' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.NtpServer" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNtpNtpServerByMoid": { "operationId": "GetNtpNtpServerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/NtpServers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/Policies": { "post": { "tags": [ "ntp" ], "summary": "Create a 'ntp.Policy' resource.", "operationId": "CreateNtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.ntp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Configure NTP settings", "PRIVSET.Create, clone and edit NTP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'ntp.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ntp.Policy' resource was created as requested. The 'ntp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } } }, "links": { "GetNtpPolicyByMoid": { "operationId": "GetNtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.Policy' resource.", "operationId": "GetNtpPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.ntp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ntp.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/Policies/{Moid}": { "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.Policy' resource.", "operationId": "GetNtpPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.ntp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ntp.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNtpPolicyByMoid": { "operationId": "GetNtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ntp" ], "summary": "Update a 'ntp.Policy' resource.", "operationId": "UpdateNtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit NTP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.ntp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ntp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ntp.Policy' resource was modified as requested. The 'ntp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } } }, "links": { "GetNtpPolicyByMoid": { "operationId": "GetNtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ntp" ], "summary": "Update a 'ntp.Policy' resource.", "operationId": "PatchNtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit NTP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.ntp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ntp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ntp.Policy' resource was patched as requested. The 'ntp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.Policy" } } }, "links": { "GetNtpPolicyByMoid": { "operationId": "GetNtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ntp" ], "summary": "Delete a 'ntp.Policy' resource.", "operationId": "DeleteNtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ntp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete NTP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/PolicyInventories": { "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.PolicyInventory' resource.", "operationId": "GetNtpPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.ntp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ntp.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ntp/PolicyInventories/{Moid}": { "get": { "tags": [ "ntp" ], "summary": "Read a 'ntp.PolicyInventory' resource.", "operationId": "GetNtpPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only NTP policies", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "PRIVSET.View Unified Edge Profiles", "READ.ntp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ntp.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ntp.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetNtpPolicyInventoryByMoid": { "operationId": "GetNtpPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ntp/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/BulkInstallInfos": { "get": { "tags": [ "os" ], "summary": "Read a 'os.BulkInstallInfo' resource.", "operationId": "GetOsBulkInstallInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.BulkInstallInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.BulkInstallInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.BulkInstallInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "os" ], "summary": "Create a 'os.BulkInstallInfo' resource.", "operationId": "CreateOsBulkInstallInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.BulkInstallInfo", "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.BulkInstallInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.BulkInstallInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.BulkInstallInfo' resource was created as requested. The 'os.BulkInstallInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.BulkInstallInfo" } } }, "links": { "GetOsBulkInstallInfoByMoid": { "operationId": "GetOsBulkInstallInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/BulkInstallInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/BulkInstallInfos/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.BulkInstallInfo' resource.", "operationId": "GetOsBulkInstallInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.BulkInstallInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.BulkInstallInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.BulkInstallInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsBulkInstallInfoByMoid": { "operationId": "GetOsBulkInstallInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/BulkInstallInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Catalogs": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Catalog' resource.", "operationId": "GetOsCatalogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Servers", "READ.os.Catalog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.Catalog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Catalog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Catalogs/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Catalog' resource.", "operationId": "GetOsCatalogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "PRIVSET.View Servers", "READ.os.Catalog", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.Catalog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Catalog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsCatalogByMoid": { "operationId": "GetOsCatalogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Catalogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/ConfigurationFiles": { "get": { "tags": [ "os" ], "summary": "Read a 'os.ConfigurationFile' resource.", "operationId": "GetOsConfigurationFileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS configuration links", "PRIVSET.Delete OS configuration links", "PRIVSET.Edit OS configuration links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.ConfigurationFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.ConfigurationFile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "os" ], "summary": "Create a 'os.ConfigurationFile' resource.", "operationId": "CreateOsConfigurationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.ConfigurationFile", "PRIVSET.Account Administrator", "PRIVSET.Add OS configuration links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.ConfigurationFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.ConfigurationFile' resource was created as requested. The 'os.ConfigurationFile' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } } }, "links": { "GetOsConfigurationFileByMoid": { "operationId": "GetOsConfigurationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/ConfigurationFiles/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.ConfigurationFile' resource.", "operationId": "GetOsConfigurationFileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS configuration links", "PRIVSET.Delete OS configuration links", "PRIVSET.Edit OS configuration links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.ConfigurationFile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.ConfigurationFile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsConfigurationFileByMoid": { "operationId": "GetOsConfigurationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "os" ], "summary": "Delete a 'os.ConfigurationFile' resource.", "operationId": "DeleteOsConfigurationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.os.ConfigurationFile", "PRIVSET.Account Administrator", "PRIVSET.Delete OS configuration links", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "os" ], "summary": "Update a 'os.ConfigurationFile' resource.", "operationId": "UpdateOsConfigurationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit OS configuration links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.os.ConfigurationFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'os.ConfigurationFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.ConfigurationFile' resource was modified as requested. The 'os.ConfigurationFile' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } } }, "links": { "GetOsConfigurationFileByMoid": { "operationId": "GetOsConfigurationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "os" ], "summary": "Update a 'os.ConfigurationFile' resource.", "operationId": "PatchOsConfigurationFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit OS configuration links", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.os.ConfigurationFile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'os.ConfigurationFile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.ConfigurationFile' resource was patched as requested. The 'os.ConfigurationFile' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ConfigurationFile" } } }, "links": { "GetOsConfigurationFileByMoid": { "operationId": "GetOsConfigurationFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ConfigurationFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Distributions": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Distribution' resource.", "operationId": "GetOsDistributionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.Distribution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.Distribution' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Distribution.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Distributions/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Distribution' resource.", "operationId": "GetOsDistributionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Add OS image links", "PRIVSET.Delete OS image links", "PRIVSET.Edit OS image links", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.Distribution", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.Distribution' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Distribution" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsDistributionByMoid": { "operationId": "GetOsDistributionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Distributions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Installs": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Install' resource.", "operationId": "GetOsInstallList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.Install", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.Install' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Install.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "os" ], "summary": "Create a 'os.Install' resource.", "operationId": "CreateOsInstall", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.Install", "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.Install' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Install" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.Install' resource was created as requested. The 'os.Install' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Install" } } }, "links": { "GetOsInstallByMoid": { "operationId": "GetOsInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Installs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/Installs/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.Install' resource.", "operationId": "GetOsInstallByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.os.Install", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.Install' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.Install" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsInstallByMoid": { "operationId": "GetOsInstallByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/Installs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/OsSupports": { "post": { "tags": [ "os" ], "summary": "Create a 'os.OsSupport' resource.", "operationId": "CreateOsOsSupport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.OsSupport", "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.OsSupport' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.OsSupport" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.OsSupport' resource was created as requested. The 'os.OsSupport' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.OsSupport" } } }, "links": { "GetOsOsSupportByMoid": { "operationId": "GetOsOsSupportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/OsSupports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/SupportedVersions": { "get": { "tags": [ "os" ], "summary": "Read a 'os.SupportedVersion' resource.", "operationId": "GetOsSupportedVersionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.os.SupportedVersion", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.SupportedVersion' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.SupportedVersion.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/SupportedVersions/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.SupportedVersion' resource.", "operationId": "GetOsSupportedVersionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-only servers", "PRIVSET.Read-only software repository", "READ.os.SupportedVersion", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.SupportedVersion' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.SupportedVersion" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsSupportedVersionByMoid": { "operationId": "GetOsSupportedVersionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/SupportedVersions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/TemplateFiles": { "post": { "tags": [ "os" ], "summary": "Create a 'os.TemplateFile' resource.", "operationId": "CreateOsTemplateFile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.TemplateFile", "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.TemplateFile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.TemplateFile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.TemplateFile' resource was created as requested. The 'os.TemplateFile' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.TemplateFile" } } }, "links": { "GetOsTemplateFileByMoid": { "operationId": "GetOsTemplateFileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/TemplateFiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/ValidInstallTargets": { "post": { "tags": [ "os" ], "summary": "Create a 'os.ValidInstallTarget' resource.", "operationId": "CreateOsValidInstallTarget", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.os.ValidInstallTarget", "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'os.ValidInstallTarget' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ValidInstallTarget" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'os.ValidInstallTarget' resource was created as requested. The 'os.ValidInstallTarget' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ValidInstallTarget" } } }, "links": { "GetOsValidInstallTargetByMoid": { "operationId": "GetOsValidInstallTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ValidInstallTargets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/ValidRemoteTargets": { "get": { "tags": [ "os" ], "summary": "Read a 'os.ValidRemoteTarget' resource.", "operationId": "GetOsValidRemoteTargetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-only servers", "READ.os.ValidRemoteTarget", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'os.ValidRemoteTarget' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ValidRemoteTarget.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/os/ValidRemoteTargets/{Moid}": { "get": { "tags": [ "os" ], "summary": "Read a 'os.ValidRemoteTarget' resource.", "operationId": "GetOsValidRemoteTargetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Install operating systems", "PRIVSET.Manage Servers", "PRIVSET.Read-only servers", "READ.os.ValidRemoteTarget", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'os.ValidRemoteTarget' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/os.ValidRemoteTarget" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetOsValidRemoteTargetByMoid": { "operationId": "GetOsValidRemoteTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/os/ValidRemoteTargets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/CoprocessorCards": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.CoprocessorCard' resource.", "operationId": "GetPciCoprocessorCardList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.CoprocessorCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.CoprocessorCard' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.CoprocessorCard.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/CoprocessorCards/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.CoprocessorCard' resource.", "operationId": "GetPciCoprocessorCardByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.CoprocessorCard", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.CoprocessorCard' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.CoprocessorCard" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciCoprocessorCardByMoid": { "operationId": "GetPciCoprocessorCardByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/CoprocessorCards/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Devices": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Device' resource.", "operationId": "GetPciDeviceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Device' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Devices/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Device' resource.", "operationId": "GetPciDeviceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Device", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Device' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciDeviceByMoid": { "operationId": "GetPciDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "pci" ], "summary": "Update a 'pci.Device' resource.", "operationId": "UpdatePciDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Device" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Device' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Device' resource was modified as requested. The 'pci.Device' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device" } } }, "links": { "GetPciDeviceByMoid": { "operationId": "GetPciDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "pci" ], "summary": "Update a 'pci.Device' resource.", "operationId": "PatchPciDevice", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Device" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Device' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Device' resource was patched as requested. The 'pci.Device' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Device" } } }, "links": { "GetPciDeviceByMoid": { "operationId": "GetPciDeviceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Devices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Endpoints": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Endpoint' resource.", "operationId": "GetPciEndpointList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Endpoint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Endpoint' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Endpoint.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Endpoints/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Endpoint' resource.", "operationId": "GetPciEndpointByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Endpoint", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Endpoint' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Endpoint" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciEndpointByMoid": { "operationId": "GetPciEndpointByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Endpoints/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Links": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Link' resource.", "operationId": "GetPciLinkList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Link", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Link' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Links/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Link' resource.", "operationId": "GetPciLinkByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Link", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Link' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciLinkByMoid": { "operationId": "GetPciLinkByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "pci" ], "summary": "Update a 'pci.Link' resource.", "operationId": "UpdatePciLink", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Link" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Link' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Link' resource was modified as requested. The 'pci.Link' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link" } } }, "links": { "GetPciLinkByMoid": { "operationId": "GetPciLinkByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "pci" ], "summary": "Update a 'pci.Link' resource.", "operationId": "PatchPciLink", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Link" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Link' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Link' resource was patched as requested. The 'pci.Link' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Link" } } }, "links": { "GetPciLinkByMoid": { "operationId": "GetPciLinkByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Links/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Nodes": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Node' resource.", "operationId": "GetPciNodeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Node", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Node' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Nodes/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Node' resource.", "operationId": "GetPciNodeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Node", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Node' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciNodeByMoid": { "operationId": "GetPciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Nodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "pci" ], "summary": "Update a 'pci.Node' resource.", "operationId": "UpdatePciNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Node" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Node' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Node' resource was modified as requested. The 'pci.Node' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node" } } }, "links": { "GetPciNodeByMoid": { "operationId": "GetPciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Nodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "pci" ], "summary": "Update a 'pci.Node' resource.", "operationId": "PatchPciNode", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Node" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Node' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Node' resource was patched as requested. The 'pci.Node' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Node" } } }, "links": { "GetPciNodeByMoid": { "operationId": "GetPciNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Nodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/NodeSettings": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.NodeSetting' resource.", "operationId": "GetPciNodeSettingList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.NodeSetting", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.NodeSetting' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/NodeSettings/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.NodeSetting' resource.", "operationId": "GetPciNodeSettingByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.NodeSetting", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.NodeSetting' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciNodeSettingByMoid": { "operationId": "GetPciNodeSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/NodeSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "pci" ], "summary": "Update a 'pci.NodeSetting' resource.", "operationId": "UpdatePciNodeSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.NodeSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.NodeSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.NodeSetting' resource was modified as requested. The 'pci.NodeSetting' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting" } } }, "links": { "GetPciNodeSettingByMoid": { "operationId": "GetPciNodeSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/NodeSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "pci" ], "summary": "Update a 'pci.NodeSetting' resource.", "operationId": "PatchPciNodeSetting", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.NodeSetting" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.NodeSetting' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.NodeSetting' resource was patched as requested. The 'pci.NodeSetting' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.NodeSetting" } } }, "links": { "GetPciNodeSettingByMoid": { "operationId": "GetPciNodeSettingByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/NodeSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Ports": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Port' resource.", "operationId": "GetPciPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Port", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Port' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Port.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Ports/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Port' resource.", "operationId": "GetPciPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Port", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Port' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Port" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciPortByMoid": { "operationId": "GetPciPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Ports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Slots": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Slot' resource.", "operationId": "GetPciSlotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Slot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Slot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Slot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Slots/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Slot' resource.", "operationId": "GetPciSlotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Slot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Slot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Slot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciSlotByMoid": { "operationId": "GetPciSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Slots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Switches": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Switch' resource.", "operationId": "GetPciSwitchList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Switch", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Switch' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Switches/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Switch' resource.", "operationId": "GetPciSwitchByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.pci.Switch", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Switch' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciSwitchByMoid": { "operationId": "GetPciSwitchByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "pci" ], "summary": "Update a 'pci.Switch' resource.", "operationId": "UpdatePciSwitch", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Switch" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Switch' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Switch' resource was modified as requested. The 'pci.Switch' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch" } } }, "links": { "GetPciSwitchByMoid": { "operationId": "GetPciSwitchByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "pci" ], "summary": "Update a 'pci.Switch' resource.", "operationId": "PatchPciSwitch", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.pci.Switch" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'pci.Switch' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'pci.Switch' resource was patched as requested. The 'pci.Switch' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Switch" } } }, "links": { "GetPciSwitchByMoid": { "operationId": "GetPciSwitchByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Switches/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Zones": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Zone' resource.", "operationId": "GetPciZoneList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Zone", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'pci.Zone' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Zone.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/pci/Zones/{Moid}": { "get": { "tags": [ "pci" ], "summary": "Read a 'pci.Zone' resource.", "operationId": "GetPciZoneByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.View Servers", "READ.pci.Zone", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'pci.Zone' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pci.Zone" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPciZoneByMoid": { "operationId": "GetPciZoneByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/pci/Zones/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/ControlStates": { "get": { "tags": [ "power" ], "summary": "Read a 'power.ControlState' resource.", "operationId": "GetPowerControlStateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.ControlState", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'power.ControlState' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.ControlState.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/ControlStates/{Moid}": { "get": { "tags": [ "power" ], "summary": "Read a 'power.ControlState' resource.", "operationId": "GetPowerControlStateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.ControlState", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'power.ControlState' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.ControlState" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPowerControlStateByMoid": { "operationId": "GetPowerControlStateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/ControlStates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/Policies": { "get": { "tags": [ "power" ], "summary": "Read a 'power.Policy' resource.", "operationId": "GetPowerPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Power policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.power.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'power.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "power" ], "summary": "Create a 'power.Policy' resource.", "operationId": "CreatePowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.power.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Power policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'power.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.Policy' resource was created as requested. The 'power.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } } }, "links": { "GetPowerPolicyByMoid": { "operationId": "GetPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/Policies/{Moid}": { "get": { "tags": [ "power" ], "summary": "Read a 'power.Policy' resource.", "operationId": "GetPowerPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Power policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.power.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'power.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPowerPolicyByMoid": { "operationId": "GetPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "power" ], "summary": "Update a 'power.Policy' resource.", "operationId": "UpdatePowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Power policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.power.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'power.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.Policy' resource was modified as requested. The 'power.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } } }, "links": { "GetPowerPolicyByMoid": { "operationId": "GetPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "power" ], "summary": "Update a 'power.Policy' resource.", "operationId": "PatchPowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Power policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.power.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'power.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.Policy' resource was patched as requested. The 'power.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.Policy" } } }, "links": { "GetPowerPolicyByMoid": { "operationId": "GetPowerPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "power" ], "summary": "Delete a 'power.Policy' resource.", "operationId": "DeletePowerPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.power.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Power policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PolicyInventories": { "get": { "tags": [ "power" ], "summary": "Read a 'power.PolicyInventory' resource.", "operationId": "GetPowerPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Power policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.power.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'power.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PolicyInventories/{Moid}": { "get": { "tags": [ "power" ], "summary": "Read a 'power.PolicyInventory' resource.", "operationId": "GetPowerPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Power policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.power.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'power.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPowerPolicyInventoryByMoid": { "operationId": "GetPowerPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PowerGroups": { "post": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Create a 'power.PowerGroup' resource.", "operationId": "CreatePowerPowerGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.power.PowerGroup", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'power.PowerGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.PowerGroup' resource was created as requested. The 'power.PowerGroup' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } } }, "links": { "GetPowerPowerGroupByMoid": { "operationId": "GetPowerPowerGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PowerGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Read a 'power.PowerGroup' resource.", "operationId": "GetPowerPowerGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.PowerGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'power.PowerGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PowerGroups/{Moid}": { "get": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Read a 'power.PowerGroup' resource.", "operationId": "GetPowerPowerGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.PowerGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'power.PowerGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPowerPowerGroupByMoid": { "operationId": "GetPowerPowerGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PowerGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Update a 'power.PowerGroup' resource.", "operationId": "UpdatePowerPowerGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.power.PowerGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'power.PowerGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.PowerGroup' resource was modified as requested. The 'power.PowerGroup' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } } }, "links": { "GetPowerPowerGroupByMoid": { "operationId": "GetPowerPowerGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PowerGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Update a 'power.PowerGroup' resource.", "operationId": "PatchPowerPowerGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "ROLE.Account Administrator", "UPDATE.power.PowerGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'power.PowerGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'power.PowerGroup' resource was patched as requested. The 'power.PowerGroup' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroup" } } }, "links": { "GetPowerPowerGroupByMoid": { "operationId": "GetPowerPowerGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PowerGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Delete a 'power.PowerGroup' resource.", "operationId": "DeletePowerPowerGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.power.PowerGroup", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PowerGroupMembers": { "get": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Read a 'power.PowerGroupMember' resource.", "operationId": "GetPowerPowerGroupMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.PowerGroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'power.PowerGroupMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroupMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/power/PowerGroupMembers/{Moid}": { "get": { "tags": [ "power" ], "x-intersight-type": "SaaS", "summary": "Read a 'power.PowerGroupMember' resource.", "operationId": "GetPowerPowerGroupMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.power.PowerGroupMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'power.PowerGroupMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/power.PowerGroupMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetPowerPowerGroupMemberByMoid": { "operationId": "GetPowerPowerGroupMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/power/PowerGroupMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/processor/Units": { "get": { "tags": [ "processor" ], "summary": "Read a 'processor.Unit' resource.", "operationId": "GetProcessorUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.processor.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'processor.Unit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/processor/Units/{Moid}": { "get": { "tags": [ "processor" ], "summary": "Read a 'processor.Unit' resource.", "operationId": "GetProcessorUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only Fabric Interconnects", "PRIVSET.Read-only networking", "PRIVSET.Read-only servers", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Servers", "READ.processor.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'processor.Unit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetProcessorUnitByMoid": { "operationId": "GetProcessorUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "processor" ], "summary": "Update a 'processor.Unit' resource.", "operationId": "UpdateProcessorUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.processor.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'processor.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'processor.Unit' resource was modified as requested. The 'processor.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit" } } }, "links": { "GetProcessorUnitByMoid": { "operationId": "GetProcessorUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "processor" ], "summary": "Update a 'processor.Unit' resource.", "operationId": "PatchProcessorUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.processor.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'processor.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'processor.Unit' resource was patched as requested. The 'processor.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/processor.Unit" } } }, "links": { "GetProcessorUnitByMoid": { "operationId": "GetProcessorUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/processor/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/rack/UnitPersonalities": { "get": { "tags": [ "rack" ], "summary": "Read a 'rack.UnitPersonality' resource.", "operationId": "GetRackUnitPersonalityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.rack.UnitPersonality", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'rack.UnitPersonality' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/rack/UnitPersonalities/{Moid}": { "get": { "tags": [ "rack" ], "summary": "Read a 'rack.UnitPersonality' resource.", "operationId": "GetRackUnitPersonalityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Fabric Interconnects", "PRIVSET.View Servers", "READ.rack.UnitPersonality", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'rack.UnitPersonality' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetRackUnitPersonalityByMoid": { "operationId": "GetRackUnitPersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/rack/UnitPersonalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "rack" ], "summary": "Update a 'rack.UnitPersonality' resource.", "operationId": "UpdateRackUnitPersonality", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.rack.UnitPersonality" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'rack.UnitPersonality' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'rack.UnitPersonality' resource was modified as requested. The 'rack.UnitPersonality' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality" } } }, "links": { "GetRackUnitPersonalityByMoid": { "operationId": "GetRackUnitPersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/rack/UnitPersonalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "rack" ], "summary": "Update a 'rack.UnitPersonality' resource.", "operationId": "PatchRackUnitPersonality", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.rack.UnitPersonality" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'rack.UnitPersonality' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'rack.UnitPersonality' resource was patched as requested. The 'rack.UnitPersonality' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rack.UnitPersonality" } } }, "links": { "GetRackUnitPersonalityByMoid": { "operationId": "GetRackUnitPersonalityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/rack/UnitPersonalities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdcard/Policies": { "get": { "tags": [ "sdcard" ], "summary": "Read a 'sdcard.Policy' resource.", "operationId": "GetSdcardPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SD Card policies", "PRIVSET.View Server Profiles", "READ.sdcard.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sdcard.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "sdcard" ], "summary": "Create a 'sdcard.Policy' resource.", "operationId": "CreateSdcardPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.sdcard.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SD Card policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'sdcard.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdcard.Policy' resource was created as requested. The 'sdcard.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } } }, "links": { "GetSdcardPolicyByMoid": { "operationId": "GetSdcardPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdcard/Policies/{Moid}": { "get": { "tags": [ "sdcard" ], "summary": "Read a 'sdcard.Policy' resource.", "operationId": "GetSdcardPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SD Card policies", "PRIVSET.View Server Profiles", "READ.sdcard.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sdcard.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSdcardPolicyByMoid": { "operationId": "GetSdcardPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "sdcard" ], "summary": "Update a 'sdcard.Policy' resource.", "operationId": "UpdateSdcardPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SD Card policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.sdcard.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdcard.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdcard.Policy' resource was modified as requested. The 'sdcard.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } } }, "links": { "GetSdcardPolicyByMoid": { "operationId": "GetSdcardPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "sdcard" ], "summary": "Update a 'sdcard.Policy' resource.", "operationId": "PatchSdcardPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SD Card policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.sdcard.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sdcard.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sdcard.Policy' resource was patched as requested. The 'sdcard.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.Policy" } } }, "links": { "GetSdcardPolicyByMoid": { "operationId": "GetSdcardPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "sdcard" ], "summary": "Delete a 'sdcard.Policy' resource.", "operationId": "DeleteSdcardPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.sdcard.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete SD Card policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdcard/PolicyInventories": { "get": { "tags": [ "sdcard" ], "summary": "Read a 'sdcard.PolicyInventory' resource.", "operationId": "GetSdcardPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SD Card policies", "PRIVSET.View Server Profiles", "READ.sdcard.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sdcard.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sdcard/PolicyInventories/{Moid}": { "get": { "tags": [ "sdcard" ], "summary": "Read a 'sdcard.PolicyInventory' resource.", "operationId": "GetSdcardPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SD Card policies", "PRIVSET.View Server Profiles", "READ.sdcard.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sdcard.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sdcard.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSdcardPolicyInventoryByMoid": { "operationId": "GetSdcardPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sdcard/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/security/Units": { "get": { "tags": [ "security" ], "summary": "Read a 'security.Unit' resource.", "operationId": "GetSecurityUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.security.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'security.Unit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/security/Units/{Moid}": { "get": { "tags": [ "security" ], "summary": "Read a 'security.Unit' resource.", "operationId": "GetSecurityUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.security.Unit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'security.Unit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSecurityUnitByMoid": { "operationId": "GetSecurityUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "security" ], "summary": "Update a 'security.Unit' resource.", "operationId": "UpdateSecurityUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.security.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'security.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'security.Unit' resource was modified as requested. The 'security.Unit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit" } } }, "links": { "GetSecurityUnitByMoid": { "operationId": "GetSecurityUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "security" ], "summary": "Update a 'security.Unit' resource.", "operationId": "PatchSecurityUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.security.Unit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'security.Unit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'security.Unit' resource was patched as requested. The 'security.Unit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/security.Unit" } } }, "links": { "GetSecurityUnitByMoid": { "operationId": "GetSecurityUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/security/Units/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigChangeDetails": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigChangeDetail' resource.", "operationId": "GetServerConfigChangeDetailList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigChangeDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ConfigChangeDetail' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigChangeDetail.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigChangeDetails/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigChangeDetail' resource.", "operationId": "GetServerConfigChangeDetailByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigChangeDetail", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ConfigChangeDetail' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigChangeDetail" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerConfigChangeDetailByMoid": { "operationId": "GetServerConfigChangeDetailByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigChangeDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigImports": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigImport' resource.", "operationId": "GetServerConfigImportList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigImport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ConfigImport' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigImport.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Create a 'server.ConfigImport' resource.", "operationId": "CreateServerConfigImport", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.server.ConfigImport", "PRIVSET.Account Administrator", "PRIVSET.Import server profiles", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'server.ConfigImport' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigImport" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.ConfigImport' resource was created as requested. The 'server.ConfigImport' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigImport" } } }, "links": { "GetServerConfigImportByMoid": { "operationId": "GetServerConfigImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigImports/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigImport' resource.", "operationId": "GetServerConfigImportByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigImport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ConfigImport' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigImport" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerConfigImportByMoid": { "operationId": "GetServerConfigImportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigImports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigResults": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigResult' resource.", "operationId": "GetServerConfigResultList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ConfigResult' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigResult.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigResults/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigResult' resource.", "operationId": "GetServerConfigResultByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigResult", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ConfigResult' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigResult" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerConfigResultByMoid": { "operationId": "GetServerConfigResultByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigResults/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigResultEntries": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigResultEntry' resource.", "operationId": "GetServerConfigResultEntryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigResultEntry", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ConfigResultEntry' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigResultEntry.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ConfigResultEntries/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ConfigResultEntry' resource.", "operationId": "GetServerConfigResultEntryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.ConfigResultEntry", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ConfigResultEntry' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ConfigResultEntry" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerConfigResultEntryByMoid": { "operationId": "GetServerConfigResultEntryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ConfigResultEntries/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/DiagnosticStatuses": { "get": { "tags": [ "server" ], "summary": "Read a 'server.DiagnosticStatus' resource.", "operationId": "GetServerDiagnosticStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.DiagnosticStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.DiagnosticStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Create a 'server.DiagnosticStatus' resource.", "operationId": "CreateServerDiagnosticStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.server.DiagnosticStatus", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'server.DiagnosticStatus' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.DiagnosticStatus' resource was created as requested. The 'server.DiagnosticStatus' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } } }, "links": { "GetServerDiagnosticStatusByMoid": { "operationId": "GetServerDiagnosticStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/DiagnosticStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/DiagnosticStatuses/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.DiagnosticStatus' resource.", "operationId": "GetServerDiagnosticStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.DiagnosticStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.DiagnosticStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerDiagnosticStatusByMoid": { "operationId": "GetServerDiagnosticStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/DiagnosticStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Update a 'server.DiagnosticStatus' resource.", "operationId": "UpdateServerDiagnosticStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.DiagnosticStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.DiagnosticStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.DiagnosticStatus' resource was modified as requested. The 'server.DiagnosticStatus' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } } }, "links": { "GetServerDiagnosticStatusByMoid": { "operationId": "GetServerDiagnosticStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/DiagnosticStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "server" ], "summary": "Update a 'server.DiagnosticStatus' resource.", "operationId": "PatchServerDiagnosticStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.DiagnosticStatus" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.DiagnosticStatus' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.DiagnosticStatus' resource was patched as requested. The 'server.DiagnosticStatus' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.DiagnosticStatus" } } }, "links": { "GetServerDiagnosticStatusByMoid": { "operationId": "GetServerDiagnosticStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/DiagnosticStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "server" ], "summary": "Delete a 'server.DiagnosticStatus' resource.", "operationId": "DeleteServerDiagnosticStatus", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.server.DiagnosticStatus", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Diagnostics": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Diagnostics' resource.", "operationId": "GetServerDiagnosticsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.Diagnostics", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.Diagnostics' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Create a 'server.Diagnostics' resource.", "operationId": "CreateServerDiagnostics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.server.Diagnostics", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'server.Diagnostics' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Diagnostics' resource was created as requested. The 'server.Diagnostics' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } } }, "links": { "GetServerDiagnosticsByMoid": { "operationId": "GetServerDiagnosticsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Diagnostics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Diagnostics/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Diagnostics' resource.", "operationId": "GetServerDiagnosticsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.Diagnostics", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.Diagnostics' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerDiagnosticsByMoid": { "operationId": "GetServerDiagnosticsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Diagnostics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Update a 'server.Diagnostics' resource.", "operationId": "UpdateServerDiagnostics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.Diagnostics" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.Diagnostics' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Diagnostics' resource was modified as requested. The 'server.Diagnostics' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } } }, "links": { "GetServerDiagnosticsByMoid": { "operationId": "GetServerDiagnosticsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Diagnostics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "server" ], "summary": "Update a 'server.Diagnostics' resource.", "operationId": "PatchServerDiagnostics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.Diagnostics" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.Diagnostics' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Diagnostics' resource was patched as requested. The 'server.Diagnostics' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Diagnostics" } } }, "links": { "GetServerDiagnosticsByMoid": { "operationId": "GetServerDiagnosticsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Diagnostics/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "server" ], "summary": "Delete a 'server.Diagnostics' resource.", "operationId": "DeleteServerDiagnostics", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.server.Diagnostics", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Disruptions": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Disruption' resource.", "operationId": "GetServerDisruptionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.Disruption", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.Disruption' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Disruption.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Disruptions/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Disruption' resource.", "operationId": "GetServerDisruptionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.Disruption", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.Disruption' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Disruption" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerDisruptionByMoid": { "operationId": "GetServerDisruptionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Disruptions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/MigrationKeyDetails": { "get": { "tags": [ "server" ], "summary": "Read a 'server.MigrationKeyDetails' resource.", "operationId": "GetServerMigrationKeyDetailsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.server.MigrationKeyDetails", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.MigrationKeyDetails' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.MigrationKeyDetails.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/MigrationKeyDetails/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.MigrationKeyDetails' resource.", "operationId": "GetServerMigrationKeyDetailsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "READ.server.MigrationKeyDetails", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.MigrationKeyDetails' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.MigrationKeyDetails" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerMigrationKeyDetailsByMoid": { "operationId": "GetServerMigrationKeyDetailsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/MigrationKeyDetails/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "server" ], "summary": "Delete a 'server.MigrationKeyDetails' resource.", "operationId": "DeleteServerMigrationKeyDetails", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.server.MigrationKeyDetails", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Profiles": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Profile' resource.", "operationId": "GetServerProfileList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Server Profiles and Server Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.Profile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.Profile' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Create a 'server.Profile' resource.", "operationId": "CreateServerProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.server.Profile", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'server.Profile' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was created as requested. The 'server.Profile' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } } }, "links": { "GetServerProfileByMoid": { "operationId": "GetServerProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/Profiles/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.Profile' resource.", "operationId": "GetServerProfileByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Server Profiles and Server Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.server.Profile", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.Profile' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerProfileByMoid": { "operationId": "GetServerProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Update a 'server.Profile' resource.", "operationId": "UpdateServerProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.Profile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.Profile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was modified as requested. The 'server.Profile' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } } }, "links": { "GetServerProfileByMoid": { "operationId": "GetServerProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "server" ], "summary": "Update a 'server.Profile' resource.", "operationId": "PatchServerProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.Profile" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.Profile' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.Profile' resource was patched as requested. The 'server.Profile' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.Profile" } } }, "links": { "GetServerProfileByMoid": { "operationId": "GetServerProfileByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/Profiles/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "server" ], "summary": "Delete a 'server.Profile' resource.", "operationId": "DeleteServerProfile", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.server.Profile", "PRIVSET.Account Administrator", "PRIVSET.Delete server profiles", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ProfilePendingChangeEvals": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ProfilePendingChangeEval' resource.", "operationId": "GetServerProfilePendingChangeEvalList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.ProfilePendingChangeEval", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ProfilePendingChangeEval' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfilePendingChangeEval.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ProfilePendingChangeEvals/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ProfilePendingChangeEval' resource.", "operationId": "GetServerProfilePendingChangeEvalByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.server.ProfilePendingChangeEval", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ProfilePendingChangeEval' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfilePendingChangeEval" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerProfilePendingChangeEvalByMoid": { "operationId": "GetServerProfilePendingChangeEvalByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ProfilePendingChangeEvals/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ProfileTemplates": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ProfileTemplate' resource.", "operationId": "GetServerProfileTemplateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Server Profiles and Server Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.View Server Profiles", "READ.server.ProfileTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'server.ProfileTemplate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Create a 'server.ProfileTemplate' resource.", "operationId": "CreateServerProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.server.ProfileTemplate", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'server.ProfileTemplate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.ProfileTemplate' resource was created as requested. The 'server.ProfileTemplate' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } } }, "links": { "GetServerProfileTemplateByMoid": { "operationId": "GetServerProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/server/ProfileTemplates/{Moid}": { "get": { "tags": [ "server" ], "summary": "Read a 'server.ProfileTemplate' resource.", "operationId": "GetServerProfileTemplateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read Server Profiles and Server Profile Templates", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profile templates", "PRIVSET.View Server Profiles", "READ.server.ProfileTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'server.ProfileTemplate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetServerProfileTemplateByMoid": { "operationId": "GetServerProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "server" ], "summary": "Update a 'server.ProfileTemplate' resource.", "operationId": "UpdateServerProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.ProfileTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.ProfileTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.ProfileTemplate' resource was modified as requested. The 'server.ProfileTemplate' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } } }, "links": { "GetServerProfileTemplateByMoid": { "operationId": "GetServerProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "server" ], "summary": "Update a 'server.ProfileTemplate' resource.", "operationId": "PatchServerProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.server.ProfileTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'server.ProfileTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'server.ProfileTemplate' resource was patched as requested. The 'server.ProfileTemplate' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/server.ProfileTemplate" } } }, "links": { "GetServerProfileTemplateByMoid": { "operationId": "GetServerProfileTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/server/ProfileTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "server" ], "summary": "Delete a 'server.ProfileTemplate' resource.", "operationId": "DeleteServerProfileTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.server.ProfileTemplate", "PRIVSET.Account Administrator", "PRIVSET.Delete server profile templates", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/Policies": { "post": { "tags": [ "smtp" ], "summary": "Create a 'smtp.Policy' resource.", "operationId": "CreateSmtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.smtp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "PRIVSET.Create, clone and edit SMTP policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'smtp.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.Policy' resource was created as requested. The 'smtp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } } }, "links": { "GetSmtpPolicyByMoid": { "operationId": "GetSmtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.Policy' resource.", "operationId": "GetSmtpPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Server Profiles", "READ.smtp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'smtp.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/Policies/{Moid}": { "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.Policy' resource.", "operationId": "GetSmtpPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Server Profiles", "READ.smtp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'smtp.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSmtpPolicyByMoid": { "operationId": "GetSmtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "smtp" ], "summary": "Update a 'smtp.Policy' resource.", "operationId": "UpdateSmtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "PRIVSET.Edit SMTP policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.smtp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'smtp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.Policy' resource was modified as requested. The 'smtp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } } }, "links": { "GetSmtpPolicyByMoid": { "operationId": "GetSmtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "smtp" ], "summary": "Update a 'smtp.Policy' resource.", "operationId": "PatchSmtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "PRIVSET.Edit SMTP policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.smtp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'smtp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.Policy' resource was patched as requested. The 'smtp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.Policy" } } }, "links": { "GetSmtpPolicyByMoid": { "operationId": "GetSmtpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "smtp" ], "summary": "Delete a 'smtp.Policy' resource.", "operationId": "DeleteSmtpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.smtp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete SMTP policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/PolicyInventories": { "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.PolicyInventory' resource.", "operationId": "GetSmtpPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Server Profiles", "READ.smtp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'smtp.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/PolicyInventories/{Moid}": { "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.PolicyInventory' resource.", "operationId": "GetSmtpPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "PRIVSET.View Server Profiles", "READ.smtp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'smtp.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSmtpPolicyInventoryByMoid": { "operationId": "GetSmtpPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/PolicyTests": { "post": { "tags": [ "smtp" ], "summary": "Create a 'smtp.PolicyTest' resource.", "operationId": "CreateSmtpPolicyTest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.smtp.PolicyTest", "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'smtp.PolicyTest' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.PolicyTest' resource was created as requested. The 'smtp.PolicyTest' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } } }, "links": { "GetSmtpPolicyTestByMoid": { "operationId": "GetSmtpPolicyTestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/PolicyTests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.PolicyTest' resource.", "operationId": "GetSmtpPolicyTestList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "READ.smtp.PolicyTest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'smtp.PolicyTest' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/smtp/PolicyTests/{Moid}": { "get": { "tags": [ "smtp" ], "summary": "Read a 'smtp.PolicyTest' resource.", "operationId": "GetSmtpPolicyTestByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only SMTP policies", "READ.smtp.PolicyTest", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'smtp.PolicyTest' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSmtpPolicyTestByMoid": { "operationId": "GetSmtpPolicyTestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/PolicyTests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "smtp" ], "summary": "Update a 'smtp.PolicyTest' resource.", "operationId": "UpdateSmtpPolicyTest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "ROLE.Account Administrator", "UPDATE.smtp.PolicyTest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'smtp.PolicyTest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.PolicyTest' resource was modified as requested. The 'smtp.PolicyTest' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } } }, "links": { "GetSmtpPolicyTestByMoid": { "operationId": "GetSmtpPolicyTestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/PolicyTests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "smtp" ], "summary": "Update a 'smtp.PolicyTest' resource.", "operationId": "PatchSmtpPolicyTest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "ROLE.Account Administrator", "UPDATE.smtp.PolicyTest" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'smtp.PolicyTest' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'smtp.PolicyTest' resource was patched as requested. The 'smtp.PolicyTest' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/smtp.PolicyTest" } } }, "links": { "GetSmtpPolicyTestByMoid": { "operationId": "GetSmtpPolicyTestByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/smtp/PolicyTests/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "smtp" ], "summary": "Delete a 'smtp.PolicyTest' resource.", "operationId": "DeleteSmtpPolicyTest", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.smtp.PolicyTest", "PRIVSET.Account Administrator", "PRIVSET.Configure SMTP servers", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/snmp/Policies": { "post": { "tags": [ "snmp" ], "summary": "Create a 'snmp.Policy' resource.", "operationId": "CreateSnmpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.snmp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SNMP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'snmp.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'snmp.Policy' resource was created as requested. The 'snmp.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } } }, "links": { "GetSnmpPolicyByMoid": { "operationId": "GetSnmpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "snmp" ], "summary": "Read a 'snmp.Policy' resource.", "operationId": "GetSnmpPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SNMP policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.snmp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'snmp.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/snmp/Policies/{Moid}": { "get": { "tags": [ "snmp" ], "summary": "Read a 'snmp.Policy' resource.", "operationId": "GetSnmpPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SNMP policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.snmp.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'snmp.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSnmpPolicyByMoid": { "operationId": "GetSnmpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "snmp" ], "summary": "Update a 'snmp.Policy' resource.", "operationId": "UpdateSnmpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SNMP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.snmp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'snmp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'snmp.Policy' resource was modified as requested. The 'snmp.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } } }, "links": { "GetSnmpPolicyByMoid": { "operationId": "GetSnmpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "snmp" ], "summary": "Update a 'snmp.Policy' resource.", "operationId": "PatchSnmpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SNMP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.snmp.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'snmp.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'snmp.Policy' resource was patched as requested. The 'snmp.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.Policy" } } }, "links": { "GetSnmpPolicyByMoid": { "operationId": "GetSnmpPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "snmp" ], "summary": "Delete a 'snmp.Policy' resource.", "operationId": "DeleteSnmpPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.snmp.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete SNMP policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/snmp/PolicyInventories": { "get": { "tags": [ "snmp" ], "summary": "Read a 'snmp.PolicyInventory' resource.", "operationId": "GetSnmpPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SNMP policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.snmp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'snmp.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/snmp/PolicyInventories/{Moid}": { "get": { "tags": [ "snmp" ], "summary": "Read a 'snmp.PolicyInventory' resource.", "operationId": "GetSnmpPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SNMP policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.snmp.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'snmp.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/snmp.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSnmpPolicyInventoryByMoid": { "operationId": "GetSnmpPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/snmp/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sol/Policies": { "get": { "tags": [ "sol" ], "summary": "Read a 'sol.Policy' resource.", "operationId": "GetSolPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SOL policies", "PRIVSET.View Server Profiles", "READ.sol.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sol.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "sol" ], "summary": "Create a 'sol.Policy' resource.", "operationId": "CreateSolPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.sol.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Serial Over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'sol.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sol.Policy' resource was created as requested. The 'sol.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } } }, "links": { "GetSolPolicyByMoid": { "operationId": "GetSolPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sol/Policies/{Moid}": { "get": { "tags": [ "sol" ], "summary": "Read a 'sol.Policy' resource.", "operationId": "GetSolPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SOL policies", "PRIVSET.View Server Profiles", "READ.sol.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sol.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSolPolicyByMoid": { "operationId": "GetSolPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "sol" ], "summary": "Update a 'sol.Policy' resource.", "operationId": "UpdateSolPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Serial Over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.sol.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sol.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sol.Policy' resource was modified as requested. The 'sol.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } } }, "links": { "GetSolPolicyByMoid": { "operationId": "GetSolPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "sol" ], "summary": "Update a 'sol.Policy' resource.", "operationId": "PatchSolPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Serial Over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.sol.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'sol.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'sol.Policy' resource was patched as requested. The 'sol.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.Policy" } } }, "links": { "GetSolPolicyByMoid": { "operationId": "GetSolPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "sol" ], "summary": "Delete a 'sol.Policy' resource.", "operationId": "DeleteSolPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.sol.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Serial Over LAN policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sol/PolicyInventories": { "get": { "tags": [ "sol" ], "summary": "Read a 'sol.PolicyInventory' resource.", "operationId": "GetSolPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SOL policies", "PRIVSET.View Server Profiles", "READ.sol.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'sol.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/sol/PolicyInventories/{Moid}": { "get": { "tags": [ "sol" ], "summary": "Read a 'sol.PolicyInventory' resource.", "operationId": "GetSolPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SOL policies", "PRIVSET.View Server Profiles", "READ.sol.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'sol.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sol.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSolPolicyInventoryByMoid": { "operationId": "GetSolPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/sol/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ssh/Policies": { "post": { "tags": [ "ssh" ], "summary": "Create a 'ssh.Policy' resource.", "operationId": "CreateSshPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.ssh.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SSH policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'ssh.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was created as requested. The 'ssh.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } } }, "links": { "GetSshPolicyByMoid": { "operationId": "GetSshPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "ssh" ], "summary": "Read a 'ssh.Policy' resource.", "operationId": "GetSshPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SSH policies", "PRIVSET.View Server Profiles", "READ.ssh.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ssh.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ssh/Policies/{Moid}": { "get": { "tags": [ "ssh" ], "summary": "Read a 'ssh.Policy' resource.", "operationId": "GetSshPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SSH policies", "PRIVSET.View Server Profiles", "READ.ssh.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ssh.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSshPolicyByMoid": { "operationId": "GetSshPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "ssh" ], "summary": "Update a 'ssh.Policy' resource.", "operationId": "UpdateSshPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SSH policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.ssh.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ssh.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was modified as requested. The 'ssh.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } } }, "links": { "GetSshPolicyByMoid": { "operationId": "GetSshPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "ssh" ], "summary": "Update a 'ssh.Policy' resource.", "operationId": "PatchSshPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SSH policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.ssh.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'ssh.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'ssh.Policy' resource was patched as requested. The 'ssh.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.Policy" } } }, "links": { "GetSshPolicyByMoid": { "operationId": "GetSshPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "ssh" ], "summary": "Delete a 'ssh.Policy' resource.", "operationId": "DeleteSshPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.ssh.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete SSH policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ssh/PolicyInventories": { "get": { "tags": [ "ssh" ], "summary": "Read a 'ssh.PolicyInventory' resource.", "operationId": "GetSshPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SSH policies", "PRIVSET.View Server Profiles", "READ.ssh.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'ssh.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/ssh/PolicyInventories/{Moid}": { "get": { "tags": [ "ssh" ], "summary": "Read a 'ssh.PolicyInventory' resource.", "operationId": "GetSshPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SSH policies", "PRIVSET.View Server Profiles", "READ.ssh.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'ssh.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ssh.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSshPolicyInventoryByMoid": { "operationId": "GetSshPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/ssh/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/BatteryBackupUnits": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.BatteryBackupUnit' resource.", "operationId": "GetStorageBatteryBackupUnitList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.BatteryBackupUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.BatteryBackupUnit' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/BatteryBackupUnits/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.BatteryBackupUnit' resource.", "operationId": "GetStorageBatteryBackupUnitByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.BatteryBackupUnit", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.BatteryBackupUnit' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageBatteryBackupUnitByMoid": { "operationId": "GetStorageBatteryBackupUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/BatteryBackupUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.BatteryBackupUnit' resource.", "operationId": "UpdateStorageBatteryBackupUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.BatteryBackupUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.BatteryBackupUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.BatteryBackupUnit' resource was modified as requested. The 'storage.BatteryBackupUnit' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } } }, "links": { "GetStorageBatteryBackupUnitByMoid": { "operationId": "GetStorageBatteryBackupUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/BatteryBackupUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.BatteryBackupUnit' resource.", "operationId": "PatchStorageBatteryBackupUnit", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.BatteryBackupUnit" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.BatteryBackupUnit' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.BatteryBackupUnit' resource was patched as requested. The 'storage.BatteryBackupUnit' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } } }, "links": { "GetStorageBatteryBackupUnitByMoid": { "operationId": "GetStorageBatteryBackupUnitByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/BatteryBackupUnits/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Controllers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Controller' resource.", "operationId": "GetStorageControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.Controller' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Controllers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Controller' resource.", "operationId": "GetStorageControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Controller", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.Controller' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageControllerByMoid": { "operationId": "GetStorageControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.Controller' resource.", "operationId": "UpdateStorageController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Controller' resource was modified as requested. The 'storage.Controller' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller" } } }, "links": { "GetStorageControllerByMoid": { "operationId": "GetStorageControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.Controller' resource.", "operationId": "PatchStorageController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Controller" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Controller' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Controller' resource was patched as requested. The 'storage.Controller' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Controller" } } }, "links": { "GetStorageControllerByMoid": { "operationId": "GetStorageControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Controllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/ControllerDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.ControllerDrive' resource.", "operationId": "GetStorageControllerDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.ControllerDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.ControllerDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.ControllerDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/ControllerDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.ControllerDrive' resource.", "operationId": "GetStorageControllerDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.ControllerDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.ControllerDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.ControllerDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageControllerDriveByMoid": { "operationId": "GetStorageControllerDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/ControllerDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DiskGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DiskGroup' resource.", "operationId": "GetStorageDiskGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.DiskGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.DiskGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DiskGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DiskGroup' resource.", "operationId": "GetStorageDiskGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.DiskGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.DiskGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageDiskGroupByMoid": { "operationId": "GetStorageDiskGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.DiskGroup' resource.", "operationId": "UpdateStorageDiskGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.DiskGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DiskGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroup' resource was modified as requested. The 'storage.DiskGroup' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup" } } }, "links": { "GetStorageDiskGroupByMoid": { "operationId": "GetStorageDiskGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.DiskGroup' resource.", "operationId": "PatchStorageDiskGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.DiskGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DiskGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DiskGroup' resource was patched as requested. The 'storage.DiskGroup' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskGroup" } } }, "links": { "GetStorageDiskGroupByMoid": { "operationId": "GetStorageDiskGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DiskSlots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DiskSlot' resource.", "operationId": "GetStorageDiskSlotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.DiskSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.DiskSlot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskSlot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DiskSlots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DiskSlot' resource.", "operationId": "GetStorageDiskSlotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.DiskSlot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.DiskSlot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DiskSlot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageDiskSlotByMoid": { "operationId": "GetStorageDiskSlotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DiskSlots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DriveGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DriveGroup' resource.", "operationId": "GetStorageDriveGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.DriveGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.DriveGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Create a 'storage.DriveGroup' resource.", "operationId": "CreateStorageDriveGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.storage.DriveGroup", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'storage.DriveGroup' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveGroup' resource was created as requested. The 'storage.DriveGroup' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } } }, "links": { "GetStorageDriveGroupByMoid": { "operationId": "GetStorageDriveGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DriveGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DriveGroup' resource.", "operationId": "GetStorageDriveGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.DriveGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.DriveGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageDriveGroupByMoid": { "operationId": "GetStorageDriveGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.DriveGroup' resource.", "operationId": "UpdateStorageDriveGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Storage policies", "PRIVSET.Edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.DriveGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DriveGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveGroup' resource was modified as requested. The 'storage.DriveGroup' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } } }, "links": { "GetStorageDriveGroupByMoid": { "operationId": "GetStorageDriveGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.DriveGroup' resource.", "operationId": "PatchStorageDriveGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Storage policies", "PRIVSET.Edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.DriveGroup" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DriveGroup' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveGroup' resource was patched as requested. The 'storage.DriveGroup' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveGroup" } } }, "links": { "GetStorageDriveGroupByMoid": { "operationId": "GetStorageDriveGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "storage" ], "summary": "Delete a 'storage.DriveGroup' resource.", "operationId": "DeleteStorageDriveGroup", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.storage.DriveGroup", "PRIVSET.Account Administrator", "PRIVSET.Delete Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DriveSecurityPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DriveSecurityPolicy' resource.", "operationId": "GetStorageDriveSecurityPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Drive Security policies", "PRIVSET.View Server Profiles", "READ.storage.DriveSecurityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.DriveSecurityPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Create a 'storage.DriveSecurityPolicy' resource.", "operationId": "CreateStorageDriveSecurityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.storage.DriveSecurityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Drive Security policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'storage.DriveSecurityPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveSecurityPolicy' resource was created as requested. The 'storage.DriveSecurityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } } }, "links": { "GetStorageDriveSecurityPolicyByMoid": { "operationId": "GetStorageDriveSecurityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveSecurityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/DriveSecurityPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.DriveSecurityPolicy' resource.", "operationId": "GetStorageDriveSecurityPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Drive Security policies", "PRIVSET.View Server Profiles", "READ.storage.DriveSecurityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.DriveSecurityPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageDriveSecurityPolicyByMoid": { "operationId": "GetStorageDriveSecurityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveSecurityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.DriveSecurityPolicy' resource.", "operationId": "UpdateStorageDriveSecurityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Drive Security policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.DriveSecurityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DriveSecurityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveSecurityPolicy' resource was modified as requested. The 'storage.DriveSecurityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } } }, "links": { "GetStorageDriveSecurityPolicyByMoid": { "operationId": "GetStorageDriveSecurityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveSecurityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.DriveSecurityPolicy' resource.", "operationId": "PatchStorageDriveSecurityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Drive Security policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.DriveSecurityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.DriveSecurityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.DriveSecurityPolicy' resource was patched as requested. The 'storage.DriveSecurityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" } } }, "links": { "GetStorageDriveSecurityPolicyByMoid": { "operationId": "GetStorageDriveSecurityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/DriveSecurityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "storage" ], "summary": "Delete a 'storage.DriveSecurityPolicy' resource.", "operationId": "DeleteStorageDriveSecurityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.storage.DriveSecurityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Drive Security policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Enclosures": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Enclosure' resource.", "operationId": "GetStorageEnclosureList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Enclosure", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.Enclosure' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Enclosures/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Enclosure' resource.", "operationId": "GetStorageEnclosureByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Enclosure", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.Enclosure' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageEnclosureByMoid": { "operationId": "GetStorageEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.Enclosure' resource.", "operationId": "UpdateStorageEnclosure", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Enclosure" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Enclosure' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Enclosure' resource was modified as requested. The 'storage.Enclosure' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure" } } }, "links": { "GetStorageEnclosureByMoid": { "operationId": "GetStorageEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.Enclosure' resource.", "operationId": "PatchStorageEnclosure", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Enclosure" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Enclosure' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Enclosure' resource was patched as requested. The 'storage.Enclosure' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Enclosure" } } }, "links": { "GetStorageEnclosureByMoid": { "operationId": "GetStorageEnclosureByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Enclosures/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/EnclosureDisks": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.EnclosureDisk' resource.", "operationId": "GetStorageEnclosureDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.EnclosureDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.EnclosureDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/EnclosureDisks/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.EnclosureDisk' resource.", "operationId": "GetStorageEnclosureDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.EnclosureDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.EnclosureDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageEnclosureDiskByMoid": { "operationId": "GetStorageEnclosureDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.EnclosureDisk' resource.", "operationId": "UpdateStorageEnclosureDisk", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.EnclosureDisk" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.EnclosureDisk' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDisk' resource was modified as requested. The 'storage.EnclosureDisk' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk" } } }, "links": { "GetStorageEnclosureDiskByMoid": { "operationId": "GetStorageEnclosureDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.EnclosureDisk' resource.", "operationId": "PatchStorageEnclosureDisk", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.EnclosureDisk" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.EnclosureDisk' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDisk' resource was patched as requested. The 'storage.EnclosureDisk' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDisk" } } }, "links": { "GetStorageEnclosureDiskByMoid": { "operationId": "GetStorageEnclosureDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/EnclosureDiskSlotEps": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.EnclosureDiskSlotEp' resource.", "operationId": "GetStorageEnclosureDiskSlotEpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.EnclosureDiskSlotEp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.EnclosureDiskSlotEp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/EnclosureDiskSlotEps/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.EnclosureDiskSlotEp' resource.", "operationId": "GetStorageEnclosureDiskSlotEpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.EnclosureDiskSlotEp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.EnclosureDiskSlotEp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageEnclosureDiskSlotEpByMoid": { "operationId": "GetStorageEnclosureDiskSlotEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.EnclosureDiskSlotEp' resource.", "operationId": "UpdateStorageEnclosureDiskSlotEp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.EnclosureDiskSlotEp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.EnclosureDiskSlotEp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDiskSlotEp' resource was modified as requested. The 'storage.EnclosureDiskSlotEp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } } }, "links": { "GetStorageEnclosureDiskSlotEpByMoid": { "operationId": "GetStorageEnclosureDiskSlotEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.EnclosureDiskSlotEp' resource.", "operationId": "PatchStorageEnclosureDiskSlotEp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.EnclosureDiskSlotEp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.EnclosureDiskSlotEp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.EnclosureDiskSlotEp' resource was patched as requested. The 'storage.EnclosureDiskSlotEp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } } }, "links": { "GetStorageEnclosureDiskSlotEpByMoid": { "operationId": "GetStorageEnclosureDiskSlotEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/EnclosureDiskSlotEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FileItems": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FileItem' resource.", "operationId": "GetStorageFileItemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FileItem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FileItem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FileItem.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FileItems/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FileItem' resource.", "operationId": "GetStorageFileItemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FileItem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FileItem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FileItem" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFileItemByMoid": { "operationId": "GetStorageFileItemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FileItems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashControllers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashController' resource.", "operationId": "GetStorageFlexFlashControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexFlashController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashControllers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashController' resource.", "operationId": "GetStorageFlexFlashControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexFlashController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexFlashControllerByMoid": { "operationId": "GetStorageFlexFlashControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashController' resource.", "operationId": "UpdateStorageFlexFlashController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashController' resource was modified as requested. The 'storage.FlexFlashController' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController" } } }, "links": { "GetStorageFlexFlashControllerByMoid": { "operationId": "GetStorageFlexFlashControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashController' resource.", "operationId": "PatchStorageFlexFlashController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashController' resource was patched as requested. The 'storage.FlexFlashController' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashController" } } }, "links": { "GetStorageFlexFlashControllerByMoid": { "operationId": "GetStorageFlexFlashControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashControllerProps": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashControllerProps' resource.", "operationId": "GetStorageFlexFlashControllerPropsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashControllerProps", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexFlashControllerProps' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashControllerProps/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashControllerProps' resource.", "operationId": "GetStorageFlexFlashControllerPropsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashControllerProps", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexFlashControllerProps' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexFlashControllerPropsByMoid": { "operationId": "GetStorageFlexFlashControllerPropsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashControllerProps' resource.", "operationId": "UpdateStorageFlexFlashControllerProps", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashControllerProps" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashControllerProps' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashControllerProps' resource was modified as requested. The 'storage.FlexFlashControllerProps' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } } }, "links": { "GetStorageFlexFlashControllerPropsByMoid": { "operationId": "GetStorageFlexFlashControllerPropsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashControllerProps' resource.", "operationId": "PatchStorageFlexFlashControllerProps", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashControllerProps" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashControllerProps' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashControllerProps' resource was patched as requested. The 'storage.FlexFlashControllerProps' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } } }, "links": { "GetStorageFlexFlashControllerPropsByMoid": { "operationId": "GetStorageFlexFlashControllerPropsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashControllerProps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashPhysicalDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashPhysicalDrive' resource.", "operationId": "GetStorageFlexFlashPhysicalDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashPhysicalDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexFlashPhysicalDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashPhysicalDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashPhysicalDrive' resource.", "operationId": "GetStorageFlexFlashPhysicalDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashPhysicalDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexFlashPhysicalDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexFlashPhysicalDriveByMoid": { "operationId": "GetStorageFlexFlashPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashPhysicalDrive' resource.", "operationId": "UpdateStorageFlexFlashPhysicalDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashPhysicalDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashPhysicalDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashPhysicalDrive' resource was modified as requested. The 'storage.FlexFlashPhysicalDrive' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } } }, "links": { "GetStorageFlexFlashPhysicalDriveByMoid": { "operationId": "GetStorageFlexFlashPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashPhysicalDrive' resource.", "operationId": "PatchStorageFlexFlashPhysicalDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashPhysicalDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashPhysicalDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashPhysicalDrive' resource was patched as requested. The 'storage.FlexFlashPhysicalDrive' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } } }, "links": { "GetStorageFlexFlashPhysicalDriveByMoid": { "operationId": "GetStorageFlexFlashPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashVirtualDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashVirtualDrive' resource.", "operationId": "GetStorageFlexFlashVirtualDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashVirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexFlashVirtualDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexFlashVirtualDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexFlashVirtualDrive' resource.", "operationId": "GetStorageFlexFlashVirtualDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexFlashVirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexFlashVirtualDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexFlashVirtualDriveByMoid": { "operationId": "GetStorageFlexFlashVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashVirtualDrive' resource.", "operationId": "UpdateStorageFlexFlashVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashVirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashVirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashVirtualDrive' resource was modified as requested. The 'storage.FlexFlashVirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } } }, "links": { "GetStorageFlexFlashVirtualDriveByMoid": { "operationId": "GetStorageFlexFlashVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexFlashVirtualDrive' resource.", "operationId": "PatchStorageFlexFlashVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexFlashVirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexFlashVirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexFlashVirtualDrive' resource was patched as requested. The 'storage.FlexFlashVirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } } }, "links": { "GetStorageFlexFlashVirtualDriveByMoid": { "operationId": "GetStorageFlexFlashVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexFlashVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilControllers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilController' resource.", "operationId": "GetStorageFlexUtilControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexUtilController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilControllers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilController' resource.", "operationId": "GetStorageFlexUtilControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexUtilController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexUtilControllerByMoid": { "operationId": "GetStorageFlexUtilControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilController' resource.", "operationId": "UpdateStorageFlexUtilController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilController' resource was modified as requested. The 'storage.FlexUtilController' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController" } } }, "links": { "GetStorageFlexUtilControllerByMoid": { "operationId": "GetStorageFlexUtilControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilController' resource.", "operationId": "PatchStorageFlexUtilController", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilController" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilController' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilController' resource was patched as requested. The 'storage.FlexUtilController' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilController" } } }, "links": { "GetStorageFlexUtilControllerByMoid": { "operationId": "GetStorageFlexUtilControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilPhysicalDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilPhysicalDrive' resource.", "operationId": "GetStorageFlexUtilPhysicalDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilPhysicalDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexUtilPhysicalDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilPhysicalDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilPhysicalDrive' resource.", "operationId": "GetStorageFlexUtilPhysicalDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilPhysicalDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexUtilPhysicalDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexUtilPhysicalDriveByMoid": { "operationId": "GetStorageFlexUtilPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilPhysicalDrive' resource.", "operationId": "UpdateStorageFlexUtilPhysicalDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilPhysicalDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilPhysicalDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilPhysicalDrive' resource was modified as requested. The 'storage.FlexUtilPhysicalDrive' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } } }, "links": { "GetStorageFlexUtilPhysicalDriveByMoid": { "operationId": "GetStorageFlexUtilPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilPhysicalDrive' resource.", "operationId": "PatchStorageFlexUtilPhysicalDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilPhysicalDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilPhysicalDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilPhysicalDrive' resource was patched as requested. The 'storage.FlexUtilPhysicalDrive' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } } }, "links": { "GetStorageFlexUtilPhysicalDriveByMoid": { "operationId": "GetStorageFlexUtilPhysicalDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilPhysicalDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilVirtualDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilVirtualDrive' resource.", "operationId": "GetStorageFlexUtilVirtualDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilVirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.FlexUtilVirtualDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/FlexUtilVirtualDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.FlexUtilVirtualDrive' resource.", "operationId": "GetStorageFlexUtilVirtualDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.FlexUtilVirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.FlexUtilVirtualDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageFlexUtilVirtualDriveByMoid": { "operationId": "GetStorageFlexUtilVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilVirtualDrive' resource.", "operationId": "UpdateStorageFlexUtilVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilVirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilVirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilVirtualDrive' resource was modified as requested. The 'storage.FlexUtilVirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } } }, "links": { "GetStorageFlexUtilVirtualDriveByMoid": { "operationId": "GetStorageFlexUtilVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.FlexUtilVirtualDrive' resource.", "operationId": "PatchStorageFlexUtilVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.FlexUtilVirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.FlexUtilVirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.FlexUtilVirtualDrive' resource was patched as requested. The 'storage.FlexUtilVirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } } }, "links": { "GetStorageFlexUtilVirtualDriveByMoid": { "operationId": "GetStorageFlexUtilVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/FlexUtilVirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiArrays": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiArray' resource.", "operationId": "GetStorageHitachiArrayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiArray' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiArrays/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiArray' resource.", "operationId": "GetStorageHitachiArrayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiArray' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiArrayByMoid": { "operationId": "GetStorageHitachiArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.HitachiArray' resource.", "operationId": "UpdateStorageHitachiArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.HitachiArray" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.HitachiArray' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.HitachiArray' resource was modified as requested. The 'storage.HitachiArray' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } } }, "links": { "GetStorageHitachiArrayByMoid": { "operationId": "GetStorageHitachiArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.HitachiArray' resource.", "operationId": "PatchStorageHitachiArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.HitachiArray" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.HitachiArray' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.HitachiArray' resource was patched as requested. The 'storage.HitachiArray' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } } }, "links": { "GetStorageHitachiArrayByMoid": { "operationId": "GetStorageHitachiArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiControllers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiController' resource.", "operationId": "GetStorageHitachiControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiControllers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiController' resource.", "operationId": "GetStorageHitachiControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiControllerByMoid": { "operationId": "GetStorageHitachiControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiDisks": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiDisk' resource.", "operationId": "GetStorageHitachiDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiDisk.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiDisks/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiDisk' resource.", "operationId": "GetStorageHitachiDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiDisk" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiDiskByMoid": { "operationId": "GetStorageHitachiDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalParityGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalParityGroup' resource.", "operationId": "GetStorageHitachiExternalParityGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalParityGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiExternalParityGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalParityGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalParityGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalParityGroup' resource.", "operationId": "GetStorageHitachiExternalParityGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalParityGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiExternalParityGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalParityGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiExternalParityGroupByMoid": { "operationId": "GetStorageHitachiExternalParityGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiExternalParityGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalPathGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalPathGroup' resource.", "operationId": "GetStorageHitachiExternalPathGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalPathGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiExternalPathGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalPathGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalPathGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalPathGroup' resource.", "operationId": "GetStorageHitachiExternalPathGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalPathGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiExternalPathGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalPathGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiExternalPathGroupByMoid": { "operationId": "GetStorageHitachiExternalPathGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiExternalPathGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalStorageLuns": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalStorageLun' resource.", "operationId": "GetStorageHitachiExternalStorageLunList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalStorageLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiExternalStorageLun' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStorageLun.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalStorageLuns/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalStorageLun' resource.", "operationId": "GetStorageHitachiExternalStorageLunByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalStorageLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiExternalStorageLun' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStorageLun" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiExternalStorageLunByMoid": { "operationId": "GetStorageHitachiExternalStorageLunByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiExternalStorageLuns/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalStoragePorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalStoragePort' resource.", "operationId": "GetStorageHitachiExternalStoragePortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalStoragePort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiExternalStoragePort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiExternalStoragePorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiExternalStoragePort' resource.", "operationId": "GetStorageHitachiExternalStoragePortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiExternalStoragePort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiExternalStoragePort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiExternalStoragePortByMoid": { "operationId": "GetStorageHitachiExternalStoragePortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiExternalStoragePorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiHosts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiHost' resource.", "operationId": "GetStorageHitachiHostList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiHost", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiHost' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiHosts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiHost' resource.", "operationId": "GetStorageHitachiHostByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiHost", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiHost' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiHostByMoid": { "operationId": "GetStorageHitachiHostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiHosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiHostLuns": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiHostLun' resource.", "operationId": "GetStorageHitachiHostLunList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiHostLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiHostLun' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHostLun.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiHostLuns/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiHostLun' resource.", "operationId": "GetStorageHitachiHostLunByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiHostLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiHostLun' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHostLun" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiHostLunByMoid": { "operationId": "GetStorageHitachiHostLunByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiHostLuns/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiNvmSubsystems": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiNvmSubsystem' resource.", "operationId": "GetStorageHitachiNvmSubsystemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiNvmSubsystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiNvmSubsystem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiNvmSubsystem.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiNvmSubsystems/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiNvmSubsystem' resource.", "operationId": "GetStorageHitachiNvmSubsystemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiNvmSubsystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiNvmSubsystem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiNvmSubsystem" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiNvmSubsystemByMoid": { "operationId": "GetStorageHitachiNvmSubsystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiNvmSubsystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiParityGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiParityGroup' resource.", "operationId": "GetStorageHitachiParityGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiParityGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiParityGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiParityGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiParityGroup' resource.", "operationId": "GetStorageHitachiParityGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiParityGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiParityGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiParityGroupByMoid": { "operationId": "GetStorageHitachiParityGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiParityGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiPools": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiPool' resource.", "operationId": "GetStorageHitachiPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiPools/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiPool' resource.", "operationId": "GetStorageHitachiPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiPool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiPoolByMoid": { "operationId": "GetStorageHitachiPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiPorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiPort' resource.", "operationId": "GetStorageHitachiPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiPort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiPorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiPort' resource.", "operationId": "GetStorageHitachiPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiPort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiPortByMoid": { "operationId": "GetStorageHitachiPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairGads": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairGad' resource.", "operationId": "GetStorageHitachiRemoteCopyPairGadList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairGad", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiRemoteCopyPairGad' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairGad.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairGads/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairGad' resource.", "operationId": "GetStorageHitachiRemoteCopyPairGadByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairGad", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiRemoteCopyPairGad' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairGad" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiRemoteCopyPairGadByMoid": { "operationId": "GetStorageHitachiRemoteCopyPairGadByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiRemoteCopyPairGads/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairTcs": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairTc' resource.", "operationId": "GetStorageHitachiRemoteCopyPairTcList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairTc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiRemoteCopyPairTc' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairTc.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairTcs/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairTc' resource.", "operationId": "GetStorageHitachiRemoteCopyPairTcByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairTc", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiRemoteCopyPairTc' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairTc" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiRemoteCopyPairTcByMoid": { "operationId": "GetStorageHitachiRemoteCopyPairTcByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiRemoteCopyPairTcs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairUrs": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairUr' resource.", "operationId": "GetStorageHitachiRemoteCopyPairUrList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairUr", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiRemoteCopyPairUr' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairUr.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteCopyPairUrs/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteCopyPairUr' resource.", "operationId": "GetStorageHitachiRemoteCopyPairUrByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteCopyPairUr", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiRemoteCopyPairUr' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairUr" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiRemoteCopyPairUrByMoid": { "operationId": "GetStorageHitachiRemoteCopyPairUrByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiRemoteCopyPairUrs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteReplications": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteReplication' resource.", "operationId": "GetStorageHitachiRemoteReplicationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteReplication", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiRemoteReplication' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteReplication.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiRemoteReplications/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiRemoteReplication' resource.", "operationId": "GetStorageHitachiRemoteReplicationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiRemoteReplication", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiRemoteReplication' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteReplication" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiRemoteReplicationByMoid": { "operationId": "GetStorageHitachiRemoteReplicationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiRemoteReplications/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiSnapshots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiSnapshot' resource.", "operationId": "GetStorageHitachiSnapshotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiSnapshot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiSnapshot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiSnapshots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiSnapshot' resource.", "operationId": "GetStorageHitachiSnapshotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiSnapshot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiSnapshot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiSnapshotByMoid": { "operationId": "GetStorageHitachiSnapshotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiSnapshots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiVolumes": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiVolume' resource.", "operationId": "GetStorageHitachiVolumeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiVolume' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiVolumes/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiVolume' resource.", "operationId": "GetStorageHitachiVolumeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiVolume' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiVolumeByMoid": { "operationId": "GetStorageHitachiVolumeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiVolumes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiVolumeMigrationPairs": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiVolumeMigrationPair' resource.", "operationId": "GetStorageHitachiVolumeMigrationPairList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiVolumeMigrationPair", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HitachiVolumeMigrationPair' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolumeMigrationPair.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HitachiVolumeMigrationPairs/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HitachiVolumeMigrationPair' resource.", "operationId": "GetStorageHitachiVolumeMigrationPairByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HitachiVolumeMigrationPair", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HitachiVolumeMigrationPair' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolumeMigrationPair" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHitachiVolumeMigrationPairByMoid": { "operationId": "GetStorageHitachiVolumeMigrationPairByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HitachiVolumeMigrationPairs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HyperFlexStorageContainers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HyperFlexStorageContainer' resource.", "operationId": "GetStorageHyperFlexStorageContainerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HyperFlexStorageContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HyperFlexStorageContainer' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HyperFlexStorageContainers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HyperFlexStorageContainer' resource.", "operationId": "GetStorageHyperFlexStorageContainerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HyperFlexStorageContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HyperFlexStorageContainer' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHyperFlexStorageContainerByMoid": { "operationId": "GetStorageHyperFlexStorageContainerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HyperFlexStorageContainers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HyperFlexVolumes": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HyperFlexVolume' resource.", "operationId": "GetStorageHyperFlexVolumeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HyperFlexVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.HyperFlexVolume' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.HyperFlexVolume.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/HyperFlexVolumes/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.HyperFlexVolume' resource.", "operationId": "GetStorageHyperFlexVolumeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.HyperFlexVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.HyperFlexVolume' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.HyperFlexVolume" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageHyperFlexVolumeByMoid": { "operationId": "GetStorageHyperFlexVolumeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/HyperFlexVolumes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Items": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Item' resource.", "operationId": "GetStorageItemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Item", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.Item' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Item.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Items/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Item' resource.", "operationId": "GetStorageItemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Item", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.Item' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Item" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageItemByMoid": { "operationId": "GetStorageItemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Items/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/KnoxSecureDriveConfigurations": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.KnoxSecureDriveConfiguration' resource.", "operationId": "GetStorageKnoxSecureDriveConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.KnoxSecureDriveConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.KnoxSecureDriveConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.KnoxSecureDriveConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/KnoxSecureDriveConfigurations/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.KnoxSecureDriveConfiguration' resource.", "operationId": "GetStorageKnoxSecureDriveConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.KnoxSecureDriveConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.KnoxSecureDriveConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.KnoxSecureDriveConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageKnoxSecureDriveConfigurationByMoid": { "operationId": "GetStorageKnoxSecureDriveConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/KnoxSecureDriveConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppAggregates": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppAggregate' resource.", "operationId": "GetStorageNetAppAggregateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppAggregate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppAggregate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppAggregates/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppAggregate' resource.", "operationId": "GetStorageNetAppAggregateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppAggregate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppAggregate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppAggregateByMoid": { "operationId": "GetStorageNetAppAggregateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppAggregates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppAggregateEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppAggregateEvent' resource.", "operationId": "GetStorageNetAppAggregateEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppAggregateEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppAggregateEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppAggregateEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppAggregateEvent' resource.", "operationId": "GetStorageNetAppAggregateEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppAggregateEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppAggregateEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppAggregateEventByMoid": { "operationId": "GetStorageNetAppAggregateEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppAggregateEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppBaseDisks": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppBaseDisk' resource.", "operationId": "GetStorageNetAppBaseDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppBaseDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppBaseDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppBaseDisks/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppBaseDisk' resource.", "operationId": "GetStorageNetAppBaseDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppBaseDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppBaseDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppBaseDiskByMoid": { "operationId": "GetStorageNetAppBaseDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppBaseDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCifsServices": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCifsService' resource.", "operationId": "GetStorageNetAppCifsServiceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCifsService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppCifsService' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsService.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCifsServices/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCifsService' resource.", "operationId": "GetStorageNetAppCifsServiceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCifsService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppCifsService' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsService" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppCifsServiceByMoid": { "operationId": "GetStorageNetAppCifsServiceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppCifsServices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCifsShares": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCifsShare' resource.", "operationId": "GetStorageNetAppCifsShareList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCifsShare", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppCifsShare' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsShare.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCifsShares/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCifsShare' resource.", "operationId": "GetStorageNetAppCifsShareByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCifsShare", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppCifsShare' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsShare" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppCifsShareByMoid": { "operationId": "GetStorageNetAppCifsShareByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppCifsShares/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCloudTargets": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCloudTarget' resource.", "operationId": "GetStorageNetAppCloudTargetList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCloudTarget", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppCloudTarget' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCloudTarget.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppCloudTargets/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCloudTarget' resource.", "operationId": "GetStorageNetAppCloudTargetByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCloudTarget", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppCloudTarget' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCloudTarget" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppCloudTargetByMoid": { "operationId": "GetStorageNetAppCloudTargetByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppCloudTargets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusters": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCluster' resource.", "operationId": "GetStorageNetAppClusterList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCluster", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppCluster' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusters/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppCluster' resource.", "operationId": "GetStorageNetAppClusterByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppCluster", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppCluster' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppClusterByMoid": { "operationId": "GetStorageNetAppClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.NetAppCluster' resource.", "operationId": "UpdateStorageNetAppCluster", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.NetAppCluster" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.NetAppCluster' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.NetAppCluster' resource was modified as requested. The 'storage.NetAppCluster' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } } }, "links": { "GetStorageNetAppClusterByMoid": { "operationId": "GetStorageNetAppClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.NetAppCluster' resource.", "operationId": "PatchStorageNetAppCluster", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.NetAppCluster" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.NetAppCluster' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.NetAppCluster' resource was patched as requested. The 'storage.NetAppCluster' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } } }, "links": { "GetStorageNetAppClusterByMoid": { "operationId": "GetStorageNetAppClusterByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusters/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterEvent' resource.", "operationId": "GetStorageNetAppClusterEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppClusterEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterEvent' resource.", "operationId": "GetStorageNetAppClusterEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppClusterEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppClusterEventByMoid": { "operationId": "GetStorageNetAppClusterEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusterEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterSnapMirrorPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterSnapMirrorPolicy' resource.", "operationId": "GetStorageNetAppClusterSnapMirrorPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterSnapMirrorPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppClusterSnapMirrorPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapMirrorPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterSnapMirrorPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterSnapMirrorPolicy' resource.", "operationId": "GetStorageNetAppClusterSnapMirrorPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterSnapMirrorPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppClusterSnapMirrorPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapMirrorPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppClusterSnapMirrorPolicyByMoid": { "operationId": "GetStorageNetAppClusterSnapMirrorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusterSnapMirrorPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterSnapshotPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterSnapshotPolicy' resource.", "operationId": "GetStorageNetAppClusterSnapshotPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterSnapshotPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppClusterSnapshotPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapshotPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppClusterSnapshotPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppClusterSnapshotPolicy' resource.", "operationId": "GetStorageNetAppClusterSnapshotPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppClusterSnapshotPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppClusterSnapshotPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapshotPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppClusterSnapshotPolicyByMoid": { "operationId": "GetStorageNetAppClusterSnapshotPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppClusterSnapshotPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDataIpInterfaces": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDataIpInterface' resource.", "operationId": "GetStorageNetAppDataIpInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDataIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppDataIpInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDataIpInterfaces/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDataIpInterface' resource.", "operationId": "GetStorageNetAppDataIpInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDataIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppDataIpInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppDataIpInterfaceByMoid": { "operationId": "GetStorageNetAppDataIpInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppDataIpInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDataIpInterfaceEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDataIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppDataIpInterfaceEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDataIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppDataIpInterfaceEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDataIpInterfaceEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDataIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppDataIpInterfaceEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDataIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppDataIpInterfaceEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppDataIpInterfaceEventByMoid": { "operationId": "GetStorageNetAppDataIpInterfaceEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppDataIpInterfaceEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDiskEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDiskEvent' resource.", "operationId": "GetStorageNetAppDiskEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDiskEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppDiskEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppDiskEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppDiskEvent' resource.", "operationId": "GetStorageNetAppDiskEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppDiskEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppDiskEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppDiskEventByMoid": { "operationId": "GetStorageNetAppDiskEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppDiskEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppEthernetPorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppEthernetPort' resource.", "operationId": "GetStorageNetAppEthernetPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppEthernetPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppEthernetPort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppEthernetPorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppEthernetPort' resource.", "operationId": "GetStorageNetAppEthernetPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppEthernetPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppEthernetPort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppEthernetPortByMoid": { "operationId": "GetStorageNetAppEthernetPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppEthernetPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppEthernetPortEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppEthernetPortEvent' resource.", "operationId": "GetStorageNetAppEthernetPortEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppEthernetPortEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppEthernetPortEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppEthernetPortEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppEthernetPortEvent' resource.", "operationId": "GetStorageNetAppEthernetPortEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppEthernetPortEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppEthernetPortEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppEthernetPortEventByMoid": { "operationId": "GetStorageNetAppEthernetPortEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppEthernetPortEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppExportPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppExportPolicy' resource.", "operationId": "GetStorageNetAppExportPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppExportPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppExportPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppExportPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppExportPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppExportPolicy' resource.", "operationId": "GetStorageNetAppExportPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppExportPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppExportPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppExportPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppExportPolicyByMoid": { "operationId": "GetStorageNetAppExportPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppExportPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcInterfaces": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcInterface' resource.", "operationId": "GetStorageNetAppFcInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppFcInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcInterfaces/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcInterface' resource.", "operationId": "GetStorageNetAppFcInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppFcInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppFcInterfaceByMoid": { "operationId": "GetStorageNetAppFcInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppFcInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcInterfaceEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcInterfaceEvent' resource.", "operationId": "GetStorageNetAppFcInterfaceEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppFcInterfaceEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcInterfaceEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcInterfaceEvent' resource.", "operationId": "GetStorageNetAppFcInterfaceEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppFcInterfaceEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppFcInterfaceEventByMoid": { "operationId": "GetStorageNetAppFcInterfaceEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppFcInterfaceEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcPorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcPort' resource.", "operationId": "GetStorageNetAppFcPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppFcPort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcPorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcPort' resource.", "operationId": "GetStorageNetAppFcPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppFcPort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppFcPortByMoid": { "operationId": "GetStorageNetAppFcPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppFcPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcPortEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcPortEvent' resource.", "operationId": "GetStorageNetAppFcPortEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcPortEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppFcPortEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppFcPortEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppFcPortEvent' resource.", "operationId": "GetStorageNetAppFcPortEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppFcPortEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppFcPortEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppFcPortEventByMoid": { "operationId": "GetStorageNetAppFcPortEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppFcPortEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppInitiatorGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppInitiatorGroup' resource.", "operationId": "GetStorageNetAppInitiatorGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppInitiatorGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppInitiatorGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppInitiatorGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppInitiatorGroup' resource.", "operationId": "GetStorageNetAppInitiatorGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppInitiatorGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppInitiatorGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppInitiatorGroupByMoid": { "operationId": "GetStorageNetAppInitiatorGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppInitiatorGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIpInterfaces": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIpInterface' resource.", "operationId": "GetStorageNetAppIpInterfaceList", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppIpInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIpInterfaces/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIpInterface' resource.", "operationId": "GetStorageNetAppIpInterfaceByMoid", "deprecated": true, "x-sunset": "2027-03-01", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppIpInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppIpInterfaceByMoid": { "operationId": "GetStorageNetAppIpInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppIpInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIpInterfaceEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppIpInterfaceEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppIpInterfaceEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIpInterfaceEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppIpInterfaceEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppIpInterfaceEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppIpInterfaceEventByMoid": { "operationId": "GetStorageNetAppIpInterfaceEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppIpInterfaceEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIscsiServices": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIscsiService' resource.", "operationId": "GetStorageNetAppIscsiServiceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIscsiService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppIscsiService' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIscsiService.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppIscsiServices/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppIscsiService' resource.", "operationId": "GetStorageNetAppIscsiServiceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppIscsiService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppIscsiService' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIscsiService" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppIscsiServiceByMoid": { "operationId": "GetStorageNetAppIscsiServiceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppIscsiServices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLicenses": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLicense' resource.", "operationId": "GetStorageNetAppLicenseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLicense", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppLicense' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLicense.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLicenses/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLicense' resource.", "operationId": "GetStorageNetAppLicenseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLicense", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppLicense' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLicense" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppLicenseByMoid": { "operationId": "GetStorageNetAppLicenseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppLicenses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLuns": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLun' resource.", "operationId": "GetStorageNetAppLunList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppLun' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLuns/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLun' resource.", "operationId": "GetStorageNetAppLunByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppLun' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppLunByMoid": { "operationId": "GetStorageNetAppLunByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppLuns/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLunEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLunEvent' resource.", "operationId": "GetStorageNetAppLunEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLunEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppLunEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLunEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLunEvent' resource.", "operationId": "GetStorageNetAppLunEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLunEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppLunEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppLunEventByMoid": { "operationId": "GetStorageNetAppLunEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppLunEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLunMaps": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLunMap' resource.", "operationId": "GetStorageNetAppLunMapList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLunMap", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppLunMap' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunMap.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppLunMaps/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppLunMap' resource.", "operationId": "GetStorageNetAppLunMapByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppLunMap", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppLunMap' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunMap" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppLunMapByMoid": { "operationId": "GetStorageNetAppLunMapByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppLunMaps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNamespaces": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNamespace' resource.", "operationId": "GetStorageNetAppNamespaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNamespace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNamespace' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNamespace.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNamespaces/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNamespace' resource.", "operationId": "GetStorageNetAppNamespaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNamespace", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNamespace' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNamespace" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNamespaceByMoid": { "operationId": "GetStorageNetAppNamespaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNamespaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNfsClients": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNfsClient' resource.", "operationId": "GetStorageNetAppNfsClientList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNfsClient", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNfsClient' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsClient.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNfsClients/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNfsClient' resource.", "operationId": "GetStorageNetAppNfsClientByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNfsClient", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNfsClient' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsClient" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNfsClientByMoid": { "operationId": "GetStorageNetAppNfsClientByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNfsClients/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNfsServices": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNfsService' resource.", "operationId": "GetStorageNetAppNfsServiceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNfsService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNfsService' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsService.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNfsServices/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNfsService' resource.", "operationId": "GetStorageNetAppNfsServiceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNfsService", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNfsService' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsService" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNfsServiceByMoid": { "operationId": "GetStorageNetAppNfsServiceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNfsServices/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodes": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNode' resource.", "operationId": "GetStorageNetAppNodeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNode' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodes/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNode' resource.", "operationId": "GetStorageNetAppNodeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNode", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNode' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNodeByMoid": { "operationId": "GetStorageNetAppNodeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNodes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodeCdpNeighbors": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNodeCdpNeighbor' resource.", "operationId": "GetStorageNetAppNodeCdpNeighborList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNodeCdpNeighbor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNodeCdpNeighbor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeCdpNeighbor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodeCdpNeighbors/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNodeCdpNeighbor' resource.", "operationId": "GetStorageNetAppNodeCdpNeighborByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNodeCdpNeighbor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNodeCdpNeighbor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeCdpNeighbor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNodeCdpNeighborByMoid": { "operationId": "GetStorageNetAppNodeCdpNeighborByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNodeCdpNeighbors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodeEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNodeEvent' resource.", "operationId": "GetStorageNetAppNodeEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNodeEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNodeEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNodeEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNodeEvent' resource.", "operationId": "GetStorageNetAppNodeEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNodeEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNodeEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNodeEventByMoid": { "operationId": "GetStorageNetAppNodeEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNodeEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNonDataIpInterfaces": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNonDataIpInterface' resource.", "operationId": "GetStorageNetAppNonDataIpInterfaceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNonDataIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNonDataIpInterface' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNonDataIpInterfaces/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNonDataIpInterface' resource.", "operationId": "GetStorageNetAppNonDataIpInterfaceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNonDataIpInterface", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNonDataIpInterface' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNonDataIpInterfaceByMoid": { "operationId": "GetStorageNetAppNonDataIpInterfaceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNonDataIpInterfaces/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNonDataIpInterfaceEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNonDataIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppNonDataIpInterfaceEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNonDataIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNonDataIpInterfaceEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNonDataIpInterfaceEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNonDataIpInterfaceEvent' resource.", "operationId": "GetStorageNetAppNonDataIpInterfaceEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNonDataIpInterfaceEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNonDataIpInterfaceEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNonDataIpInterfaceEventByMoid": { "operationId": "GetStorageNetAppNonDataIpInterfaceEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNonDataIpInterfaceEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNtpServers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNtpServer' resource.", "operationId": "GetStorageNetAppNtpServerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNtpServer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppNtpServer' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNtpServer.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppNtpServers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppNtpServer' resource.", "operationId": "GetStorageNetAppNtpServerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppNtpServer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppNtpServer' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNtpServer" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppNtpServerByMoid": { "operationId": "GetStorageNetAppNtpServerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppNtpServers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppQtrees": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppQtree' resource.", "operationId": "GetStorageNetAppQtreeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppQtree", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppQtree' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppQtree.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppQtrees/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppQtree' resource.", "operationId": "GetStorageNetAppQtreeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppQtree", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppQtree' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppQtree" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppQtreeByMoid": { "operationId": "GetStorageNetAppQtreeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppQtrees/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSchedules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSchedule' resource.", "operationId": "GetStorageNetAppScheduleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSchedule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSchedule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSchedules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSchedule' resource.", "operationId": "GetStorageNetAppScheduleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSchedule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSchedule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppScheduleByMoid": { "operationId": "GetStorageNetAppScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSensors": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSensor' resource.", "operationId": "GetStorageNetAppSensorList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSensor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSensor' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSensor.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSensors/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSensor' resource.", "operationId": "GetStorageNetAppSensorByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSensor", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSensor' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSensor" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppSensorByMoid": { "operationId": "GetStorageNetAppSensorByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSensors/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSnapMirrorRelationships": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSnapMirrorRelationship' resource.", "operationId": "GetStorageNetAppSnapMirrorRelationshipList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSnapMirrorRelationship", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSnapMirrorRelationship' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSnapMirrorRelationship.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSnapMirrorRelationships/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSnapMirrorRelationship' resource.", "operationId": "GetStorageNetAppSnapMirrorRelationshipByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSnapMirrorRelationship", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSnapMirrorRelationship' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSnapMirrorRelationship" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppSnapMirrorRelationshipByMoid": { "operationId": "GetStorageNetAppSnapMirrorRelationshipByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSnapMirrorRelationships/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppStorageVms": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppStorageVm' resource.", "operationId": "GetStorageNetAppStorageVmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppStorageVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppStorageVm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppStorageVms/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppStorageVm' resource.", "operationId": "GetStorageNetAppStorageVmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppStorageVm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppStorageVm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppStorageVmByMoid": { "operationId": "GetStorageNetAppStorageVmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppStorageVms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmEvent' resource.", "operationId": "GetStorageNetAppSvmEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSvmEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmEvent' resource.", "operationId": "GetStorageNetAppSvmEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSvmEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppSvmEventByMoid": { "operationId": "GetStorageNetAppSvmEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSvmEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmSnapMirrorPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmSnapMirrorPolicy' resource.", "operationId": "GetStorageNetAppSvmSnapMirrorPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmSnapMirrorPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSvmSnapMirrorPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapMirrorPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmSnapMirrorPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmSnapMirrorPolicy' resource.", "operationId": "GetStorageNetAppSvmSnapMirrorPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmSnapMirrorPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSvmSnapMirrorPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapMirrorPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppSvmSnapMirrorPolicyByMoid": { "operationId": "GetStorageNetAppSvmSnapMirrorPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSvmSnapMirrorPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmSnapshotPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmSnapshotPolicy' resource.", "operationId": "GetStorageNetAppSvmSnapshotPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmSnapshotPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppSvmSnapshotPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapshotPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppSvmSnapshotPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppSvmSnapshotPolicy' resource.", "operationId": "GetStorageNetAppSvmSnapshotPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppSvmSnapshotPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppSvmSnapshotPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapshotPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppSvmSnapshotPolicyByMoid": { "operationId": "GetStorageNetAppSvmSnapshotPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppSvmSnapshotPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumes": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolume' resource.", "operationId": "GetStorageNetAppVolumeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppVolume' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumes/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolume' resource.", "operationId": "GetStorageNetAppVolumeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppVolume' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppVolumeByMoid": { "operationId": "GetStorageNetAppVolumeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppVolumes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumeEvents": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolumeEvent' resource.", "operationId": "GetStorageNetAppVolumeEventList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolumeEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppVolumeEvent' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumeEvents/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolumeEvent' resource.", "operationId": "GetStorageNetAppVolumeEventByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolumeEvent", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppVolumeEvent' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppVolumeEventByMoid": { "operationId": "GetStorageNetAppVolumeEventByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppVolumeEvents/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumeSnapshots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolumeSnapshot' resource.", "operationId": "GetStorageNetAppVolumeSnapshotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolumeSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NetAppVolumeSnapshot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeSnapshot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NetAppVolumeSnapshots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NetAppVolumeSnapshot' resource.", "operationId": "GetStorageNetAppVolumeSnapshotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.NetAppVolumeSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NetAppVolumeSnapshot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeSnapshot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNetAppVolumeSnapshotByMoid": { "operationId": "GetStorageNetAppVolumeSnapshotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NetAppVolumeSnapshots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NvmeRaidConfigurations": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NvmeRaidConfiguration' resource.", "operationId": "GetStorageNvmeRaidConfigurationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.NvmeRaidConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.NvmeRaidConfiguration' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.NvmeRaidConfiguration.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/NvmeRaidConfigurations/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.NvmeRaidConfiguration' resource.", "operationId": "GetStorageNvmeRaidConfigurationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.NvmeRaidConfiguration", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.NvmeRaidConfiguration' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.NvmeRaidConfiguration" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageNvmeRaidConfigurationByMoid": { "operationId": "GetStorageNvmeRaidConfigurationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/NvmeRaidConfigurations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDisks": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDisk' resource.", "operationId": "GetStoragePhysicalDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PhysicalDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDisks/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDisk' resource.", "operationId": "GetStoragePhysicalDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PhysicalDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePhysicalDiskByMoid": { "operationId": "GetStoragePhysicalDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDisk' resource.", "operationId": "UpdateStoragePhysicalDisk", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDisk" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDisk' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDisk' resource was modified as requested. The 'storage.PhysicalDisk' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk" } } }, "links": { "GetStoragePhysicalDiskByMoid": { "operationId": "GetStoragePhysicalDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDisk' resource.", "operationId": "PatchStoragePhysicalDisk", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDisk" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDisk' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDisk' resource was patched as requested. The 'storage.PhysicalDisk' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDisk" } } }, "links": { "GetStoragePhysicalDiskByMoid": { "operationId": "GetStoragePhysicalDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDiskExtensions": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDiskExtension' resource.", "operationId": "GetStoragePhysicalDiskExtensionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDiskExtension", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PhysicalDiskExtension' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDiskExtensions/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDiskExtension' resource.", "operationId": "GetStoragePhysicalDiskExtensionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDiskExtension", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PhysicalDiskExtension' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePhysicalDiskExtensionByMoid": { "operationId": "GetStoragePhysicalDiskExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDiskExtension' resource.", "operationId": "UpdateStoragePhysicalDiskExtension", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDiskExtension" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDiskExtension' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskExtension' resource was modified as requested. The 'storage.PhysicalDiskExtension' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } } }, "links": { "GetStoragePhysicalDiskExtensionByMoid": { "operationId": "GetStoragePhysicalDiskExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDiskExtension' resource.", "operationId": "PatchStoragePhysicalDiskExtension", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDiskExtension" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDiskExtension' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskExtension' resource was patched as requested. The 'storage.PhysicalDiskExtension' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } } }, "links": { "GetStoragePhysicalDiskExtensionByMoid": { "operationId": "GetStoragePhysicalDiskExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDiskUsages": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDiskUsage' resource.", "operationId": "GetStoragePhysicalDiskUsageList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDiskUsage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PhysicalDiskUsage' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PhysicalDiskUsages/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PhysicalDiskUsage' resource.", "operationId": "GetStoragePhysicalDiskUsageByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.PhysicalDiskUsage", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PhysicalDiskUsage' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePhysicalDiskUsageByMoid": { "operationId": "GetStoragePhysicalDiskUsageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDiskUsage' resource.", "operationId": "UpdateStoragePhysicalDiskUsage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDiskUsage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDiskUsage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskUsage' resource was modified as requested. The 'storage.PhysicalDiskUsage' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } } }, "links": { "GetStoragePhysicalDiskUsageByMoid": { "operationId": "GetStoragePhysicalDiskUsageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.PhysicalDiskUsage' resource.", "operationId": "PatchStoragePhysicalDiskUsage", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.PhysicalDiskUsage" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PhysicalDiskUsage' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PhysicalDiskUsage' resource was patched as requested. The 'storage.PhysicalDiskUsage' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } } }, "links": { "GetStoragePhysicalDiskUsageByMoid": { "operationId": "GetStoragePhysicalDiskUsageByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PhysicalDiskUsages/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureArrays": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureArray' resource.", "operationId": "GetStoragePureArrayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureArray' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureArrays/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureArray' resource.", "operationId": "GetStoragePureArrayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureArray' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureArrayByMoid": { "operationId": "GetStoragePureArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.PureArray' resource.", "operationId": "UpdateStoragePureArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.PureArray" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PureArray' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureArray' resource was modified as requested. The 'storage.PureArray' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } } }, "links": { "GetStoragePureArrayByMoid": { "operationId": "GetStoragePureArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.PureArray' resource.", "operationId": "PatchStoragePureArray", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.PureArray" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PureArray' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureArray' resource was patched as requested. The 'storage.PureArray' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } } }, "links": { "GetStoragePureArrayByMoid": { "operationId": "GetStoragePureArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureArrayAlerts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureArrayAlerts' resource.", "operationId": "GetStoragePureArrayAlertsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureArrayAlerts", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureArrayAlerts' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArrayAlerts.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureArrayAlerts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureArrayAlerts' resource.", "operationId": "GetStoragePureArrayAlertsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureArrayAlerts", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureArrayAlerts' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArrayAlerts" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureArrayAlertsByMoid": { "operationId": "GetStoragePureArrayAlertsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureArrayAlerts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureBlades": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureBlade' resource.", "operationId": "GetStoragePureBladeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureBlade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureBlade' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureBlade.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureBlades/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureBlade' resource.", "operationId": "GetStoragePureBladeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureBlade", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureBlade' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureBlade" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureBladeByMoid": { "operationId": "GetStoragePureBladeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureBlades/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureControllers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureController' resource.", "operationId": "GetStoragePureControllerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureController' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureControllers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureController' resource.", "operationId": "GetStoragePureControllerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureController", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureController' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureControllerByMoid": { "operationId": "GetStoragePureControllerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureControllers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectories": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectory' resource.", "operationId": "GetStoragePureDirectoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDirectory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectories/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectory' resource.", "operationId": "GetStoragePureDirectoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDirectory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDirectoryByMoid": { "operationId": "GetStoragePureDirectoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDirectories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryExports": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryExport' resource.", "operationId": "GetStoragePureDirectoryExportList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryExport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDirectoryExport' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryExports/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryExport' resource.", "operationId": "GetStoragePureDirectoryExportByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryExport", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDirectoryExport' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDirectoryExportByMoid": { "operationId": "GetStoragePureDirectoryExportByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDirectoryExports/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryPolicy' resource.", "operationId": "GetStoragePureDirectoryPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDirectoryPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryPolicy' resource.", "operationId": "GetStoragePureDirectoryPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDirectoryPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDirectoryPolicyByMoid": { "operationId": "GetStoragePureDirectoryPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDirectoryPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryQuota": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryQuota' resource.", "operationId": "GetStoragePureDirectoryQuotaList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryQuota", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDirectoryQuota' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectoryQuota/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectoryQuota' resource.", "operationId": "GetStoragePureDirectoryQuotaByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectoryQuota", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDirectoryQuota' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDirectoryQuotaByMoid": { "operationId": "GetStoragePureDirectoryQuotaByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDirectoryQuota/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectorySnapshots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectorySnapshot' resource.", "operationId": "GetStoragePureDirectorySnapshotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectorySnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDirectorySnapshot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectorySnapshot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDirectorySnapshots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDirectorySnapshot' resource.", "operationId": "GetStoragePureDirectorySnapshotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDirectorySnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDirectorySnapshot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectorySnapshot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDirectorySnapshotByMoid": { "operationId": "GetStoragePureDirectorySnapshotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDirectorySnapshots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDisks": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDisk' resource.", "operationId": "GetStoragePureDiskList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureDisk' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDisk.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureDisks/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureDisk' resource.", "operationId": "GetStoragePureDiskByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureDisk", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureDisk' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDisk" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureDiskByMoid": { "operationId": "GetStoragePureDiskByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureDisks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFileSystems": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFileSystems' resource.", "operationId": "GetStoragePureFileSystemsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureFileSystems", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureFileSystems' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFileSystems/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFileSystems' resource.", "operationId": "GetStoragePureFileSystemsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureFileSystems", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureFileSystems' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureFileSystemsByMoid": { "operationId": "GetStoragePureFileSystemsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureFileSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFlashBladeFileSystems": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFlashBladeFileSystem' resource.", "operationId": "GetStoragePureFlashBladeFileSystemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureFlashBladeFileSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureFlashBladeFileSystem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeFileSystem.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFlashBladeFileSystems/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFlashBladeFileSystem' resource.", "operationId": "GetStoragePureFlashBladeFileSystemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureFlashBladeFileSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureFlashBladeFileSystem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeFileSystem" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureFlashBladeFileSystemByMoid": { "operationId": "GetStoragePureFlashBladeFileSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureFlashBladeFileSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFlashBladeSystems": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFlashBladeSystem' resource.", "operationId": "GetStoragePureFlashBladeSystemList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureFlashBladeSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureFlashBladeSystem' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureFlashBladeSystems/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureFlashBladeSystem' resource.", "operationId": "GetStoragePureFlashBladeSystemByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureFlashBladeSystem", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureFlashBladeSystem' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureFlashBladeSystemByMoid": { "operationId": "GetStoragePureFlashBladeSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureFlashBladeSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.PureFlashBladeSystem' resource.", "operationId": "UpdateStoragePureFlashBladeSystem", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.PureFlashBladeSystem" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PureFlashBladeSystem' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureFlashBladeSystem' resource was modified as requested. The 'storage.PureFlashBladeSystem' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } } }, "links": { "GetStoragePureFlashBladeSystemByMoid": { "operationId": "GetStoragePureFlashBladeSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureFlashBladeSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.PureFlashBladeSystem' resource.", "operationId": "PatchStoragePureFlashBladeSystem", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "ROLE.Account Administrator", "UPDATE.storage.PureFlashBladeSystem" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.PureFlashBladeSystem' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.PureFlashBladeSystem' resource was patched as requested. The 'storage.PureFlashBladeSystem' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } } }, "links": { "GetStoragePureFlashBladeSystemByMoid": { "operationId": "GetStoragePureFlashBladeSystemByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureFlashBladeSystems/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHosts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHost' resource.", "operationId": "GetStoragePureHostList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHost", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureHost' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHosts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHost' resource.", "operationId": "GetStoragePureHostByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHost", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureHost' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureHostByMoid": { "operationId": "GetStoragePureHostByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHosts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHostGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHostGroup' resource.", "operationId": "GetStoragePureHostGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHostGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureHostGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHostGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHostGroup' resource.", "operationId": "GetStoragePureHostGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHostGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureHostGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureHostGroupByMoid": { "operationId": "GetStoragePureHostGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHostGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHostLuns": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHostLun' resource.", "operationId": "GetStoragePureHostLunList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHostLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureHostLun' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostLun.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureHostLuns/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureHostLun' resource.", "operationId": "GetStoragePureHostLunByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureHostLun", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureHostLun' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostLun" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureHostLunByMoid": { "operationId": "GetStoragePureHostLunByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureHostLuns/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureManagementAccessPolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureManagementAccessPolicy' resource.", "operationId": "GetStoragePureManagementAccessPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureManagementAccessPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureManagementAccessPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureManagementAccessPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureManagementAccessPolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureManagementAccessPolicy' resource.", "operationId": "GetStoragePureManagementAccessPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureManagementAccessPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureManagementAccessPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureManagementAccessPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureManagementAccessPolicyByMoid": { "operationId": "GetStoragePureManagementAccessPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureManagementAccessPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureNfsPolicyRules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureNfsPolicyRule' resource.", "operationId": "GetStoragePureNfsPolicyRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureNfsPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureNfsPolicyRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureNfsPolicyRules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureNfsPolicyRule' resource.", "operationId": "GetStoragePureNfsPolicyRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureNfsPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureNfsPolicyRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureNfsPolicyRuleByMoid": { "operationId": "GetStoragePureNfsPolicyRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureNfsPolicyRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectBuckets": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectBucket' resource.", "operationId": "GetStoragePureObjectBucketList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectBucket", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureObjectBucket' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectBucket.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectBuckets/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectBucket' resource.", "operationId": "GetStoragePureObjectBucketByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectBucket", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureObjectBucket' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectBucket" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureObjectBucketByMoid": { "operationId": "GetStoragePureObjectBucketByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureObjectBuckets/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectStoreAccounts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectStoreAccount' resource.", "operationId": "GetStoragePureObjectStoreAccountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectStoreAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureObjectStoreAccount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectStoreAccounts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectStoreAccount' resource.", "operationId": "GetStoragePureObjectStoreAccountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectStoreAccount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureObjectStoreAccount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureObjectStoreAccountByMoid": { "operationId": "GetStoragePureObjectStoreAccountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureObjectStoreAccounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectStoreUsers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectStoreUser' resource.", "operationId": "GetStoragePureObjectStoreUserList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectStoreUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureObjectStoreUser' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreUser.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureObjectStoreUsers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureObjectStoreUser' resource.", "operationId": "GetStoragePureObjectStoreUserByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureObjectStoreUser", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureObjectStoreUser' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreUser" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureObjectStoreUserByMoid": { "operationId": "GetStoragePureObjectStoreUserByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureObjectStoreUsers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PurePods": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PurePod' resource.", "operationId": "GetStoragePurePodList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PurePod", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PurePod' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PurePods/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PurePod' resource.", "operationId": "GetStoragePurePodByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PurePod", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PurePod' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePurePodByMoid": { "operationId": "GetStoragePurePodByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PurePods/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PurePorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PurePort' resource.", "operationId": "GetStoragePurePortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PurePort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PurePort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PurePorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PurePort' resource.", "operationId": "GetStoragePurePortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PurePort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PurePort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePurePortByMoid": { "operationId": "GetStoragePurePortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PurePorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureProtectionGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureProtectionGroup' resource.", "operationId": "GetStoragePureProtectionGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureProtectionGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureProtectionGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureProtectionGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureProtectionGroup' resource.", "operationId": "GetStoragePureProtectionGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureProtectionGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureProtectionGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureProtectionGroupByMoid": { "operationId": "GetStoragePureProtectionGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureProtectionGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureProtectionGroupSnapshots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureProtectionGroupSnapshot' resource.", "operationId": "GetStoragePureProtectionGroupSnapshotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureProtectionGroupSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureProtectionGroupSnapshot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureProtectionGroupSnapshots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureProtectionGroupSnapshot' resource.", "operationId": "GetStoragePureProtectionGroupSnapshotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureProtectionGroupSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureProtectionGroupSnapshot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureProtectionGroupSnapshotByMoid": { "operationId": "GetStoragePureProtectionGroupSnapshotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureProtectionGroupSnapshots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureQuotaPolicyRules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureQuotaPolicyRule' resource.", "operationId": "GetStoragePureQuotaPolicyRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureQuotaPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureQuotaPolicyRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureQuotaPolicyRules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureQuotaPolicyRule' resource.", "operationId": "GetStoragePureQuotaPolicyRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureQuotaPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureQuotaPolicyRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureQuotaPolicyRuleByMoid": { "operationId": "GetStoragePureQuotaPolicyRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureQuotaPolicyRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureRealms": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureRealm' resource.", "operationId": "GetStoragePureRealmList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureRealm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureRealm' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureRealms/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureRealm' resource.", "operationId": "GetStoragePureRealmByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureRealm", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureRealm' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureRealmByMoid": { "operationId": "GetStoragePureRealmByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureRealms/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureReplicationSchedules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureReplicationSchedule' resource.", "operationId": "GetStoragePureReplicationScheduleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureReplicationSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureReplicationSchedule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureReplicationSchedule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureReplicationSchedules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureReplicationSchedule' resource.", "operationId": "GetStoragePureReplicationScheduleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureReplicationSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureReplicationSchedule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureReplicationSchedule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureReplicationScheduleByMoid": { "operationId": "GetStoragePureReplicationScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureReplicationSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureSmbPolicyRules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureSmbPolicyRule' resource.", "operationId": "GetStoragePureSmbPolicyRuleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureSmbPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureSmbPolicyRule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureSmbPolicyRules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureSmbPolicyRule' resource.", "operationId": "GetStoragePureSmbPolicyRuleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureSmbPolicyRule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureSmbPolicyRule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureSmbPolicyRuleByMoid": { "operationId": "GetStoragePureSmbPolicyRuleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureSmbPolicyRules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureSnapshotSchedules": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureSnapshotSchedule' resource.", "operationId": "GetStoragePureSnapshotScheduleList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureSnapshotSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureSnapshotSchedule' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSnapshotSchedule.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureSnapshotSchedules/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureSnapshotSchedule' resource.", "operationId": "GetStoragePureSnapshotScheduleByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureSnapshotSchedule", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureSnapshotSchedule' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSnapshotSchedule" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureSnapshotScheduleByMoid": { "operationId": "GetStoragePureSnapshotScheduleByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureSnapshotSchedules/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureTargetArrays": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureTargetArray' resource.", "operationId": "GetStoragePureTargetArrayList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureTargetArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureTargetArray' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureTargetArray.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureTargetArrays/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureTargetArray' resource.", "operationId": "GetStoragePureTargetArrayByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureTargetArray", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureTargetArray' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureTargetArray" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureTargetArrayByMoid": { "operationId": "GetStoragePureTargetArrayByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureTargetArrays/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumes": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolume' resource.", "operationId": "GetStoragePureVolumeList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureVolume' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumes/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolume' resource.", "operationId": "GetStoragePureVolumeByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureVolume", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureVolume' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureVolumeByMoid": { "operationId": "GetStoragePureVolumeByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureVolumes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumeGroups": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolumeGroup' resource.", "operationId": "GetStoragePureVolumeGroupList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureVolumeGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureVolumeGroup' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeGroup.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumeGroups/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolumeGroup' resource.", "operationId": "GetStoragePureVolumeGroupByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.View Storage Arrays", "READ.storage.PureVolumeGroup", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureVolumeGroup' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeGroup" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureVolumeGroupByMoid": { "operationId": "GetStoragePureVolumeGroupByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureVolumeGroups/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumeSnapshots": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolumeSnapshot' resource.", "operationId": "GetStoragePureVolumeSnapshotList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureVolumeSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.PureVolumeSnapshot' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/PureVolumeSnapshots/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.PureVolumeSnapshot' resource.", "operationId": "GetStoragePureVolumeSnapshotByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Storage Arrays", "PRIVSET.Read-Only", "PRIVSET.Read-only storage", "PRIVSET.View Storage Arrays", "READ.storage.PureVolumeSnapshot", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.PureVolumeSnapshot' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStoragePureVolumeSnapshotByMoid": { "operationId": "GetStoragePureVolumeSnapshotByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/PureVolumeSnapshots/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/SasExpanders": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.SasExpander' resource.", "operationId": "GetStorageSasExpanderList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.SasExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.SasExpander' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/SasExpanders/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.SasExpander' resource.", "operationId": "GetStorageSasExpanderByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.SasExpander", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.SasExpander' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageSasExpanderByMoid": { "operationId": "GetStorageSasExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.SasExpander' resource.", "operationId": "UpdateStorageSasExpander", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.SasExpander" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.SasExpander' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasExpander' resource was modified as requested. The 'storage.SasExpander' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander" } } }, "links": { "GetStorageSasExpanderByMoid": { "operationId": "GetStorageSasExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.SasExpander' resource.", "operationId": "PatchStorageSasExpander", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.SasExpander" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.SasExpander' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasExpander' resource was patched as requested. The 'storage.SasExpander' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasExpander" } } }, "links": { "GetStorageSasExpanderByMoid": { "operationId": "GetStorageSasExpanderByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasExpanders/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/SasPorts": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.SasPort' resource.", "operationId": "GetStorageSasPortList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.SasPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.SasPort' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/SasPorts/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.SasPort' resource.", "operationId": "GetStorageSasPortByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.SasPort", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.SasPort' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageSasPortByMoid": { "operationId": "GetStorageSasPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.SasPort' resource.", "operationId": "UpdateStorageSasPort", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.SasPort" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.SasPort' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasPort' resource was modified as requested. The 'storage.SasPort' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort" } } }, "links": { "GetStorageSasPortByMoid": { "operationId": "GetStorageSasPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.SasPort' resource.", "operationId": "PatchStorageSasPort", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.SasPort" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.SasPort' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.SasPort' resource was patched as requested. The 'storage.SasPort' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.SasPort" } } }, "links": { "GetStorageSasPortByMoid": { "operationId": "GetStorageSasPortByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/SasPorts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Spans": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Span' resource.", "operationId": "GetStorageSpanList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Span", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.Span' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/Spans/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.Span' resource.", "operationId": "GetStorageSpanByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.Span", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.Span' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageSpanByMoid": { "operationId": "GetStorageSpanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.Span' resource.", "operationId": "UpdateStorageSpan", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Span" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Span' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Span' resource was modified as requested. The 'storage.Span' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span" } } }, "links": { "GetStorageSpanByMoid": { "operationId": "GetStorageSpanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.Span' resource.", "operationId": "PatchStorageSpan", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.Span" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.Span' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.Span' resource was patched as requested. The 'storage.Span' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.Span" } } }, "links": { "GetStorageSpanByMoid": { "operationId": "GetStorageSpanByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/Spans/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/StoragePolicies": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.StoragePolicy' resource.", "operationId": "GetStorageStoragePolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.StoragePolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.StoragePolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Create a 'storage.StoragePolicy' resource.", "operationId": "CreateStorageStoragePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.storage.StoragePolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'storage.StoragePolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was created as requested. The 'storage.StoragePolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } } }, "links": { "GetStorageStoragePolicyByMoid": { "operationId": "GetStorageStoragePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/StoragePolicies/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.StoragePolicy' resource.", "operationId": "GetStorageStoragePolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.StoragePolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.StoragePolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageStoragePolicyByMoid": { "operationId": "GetStorageStoragePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.StoragePolicy' resource.", "operationId": "UpdateStorageStoragePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.StoragePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.StoragePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was modified as requested. The 'storage.StoragePolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } } }, "links": { "GetStorageStoragePolicyByMoid": { "operationId": "GetStorageStoragePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.StoragePolicy' resource.", "operationId": "PatchStorageStoragePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.storage.StoragePolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.StoragePolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.StoragePolicy' resource was patched as requested. The 'storage.StoragePolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.StoragePolicy" } } }, "links": { "GetStorageStoragePolicyByMoid": { "operationId": "GetStorageStoragePolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/StoragePolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "storage" ], "summary": "Delete a 'storage.StoragePolicy' resource.", "operationId": "DeleteStorageStoragePolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.storage.StoragePolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Storage policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VdMemberEps": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VdMemberEp' resource.", "operationId": "GetStorageVdMemberEpList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VdMemberEp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.VdMemberEp' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VdMemberEps/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VdMemberEp' resource.", "operationId": "GetStorageVdMemberEpByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VdMemberEp", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.VdMemberEp' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageVdMemberEpByMoid": { "operationId": "GetStorageVdMemberEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.VdMemberEp' resource.", "operationId": "UpdateStorageVdMemberEp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VdMemberEp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VdMemberEp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VdMemberEp' resource was modified as requested. The 'storage.VdMemberEp' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp" } } }, "links": { "GetStorageVdMemberEpByMoid": { "operationId": "GetStorageVdMemberEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.VdMemberEp' resource.", "operationId": "PatchStorageVdMemberEp", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VdMemberEp" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VdMemberEp' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VdMemberEp' resource was patched as requested. The 'storage.VdMemberEp' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VdMemberEp" } } }, "links": { "GetStorageVdMemberEpByMoid": { "operationId": "GetStorageVdMemberEpByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VdMemberEps/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDrives": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDrive' resource.", "operationId": "GetStorageVirtualDriveList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.VirtualDrive' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDrives/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDrive' resource.", "operationId": "GetStorageVirtualDriveByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDrive", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.VirtualDrive' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageVirtualDriveByMoid": { "operationId": "GetStorageVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDrive' resource.", "operationId": "UpdateStorageVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDrive' resource was modified as requested. The 'storage.VirtualDrive' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive" } } }, "links": { "GetStorageVirtualDriveByMoid": { "operationId": "GetStorageVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDrive' resource.", "operationId": "PatchStorageVirtualDrive", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDrive" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDrive' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDrive' resource was patched as requested. The 'storage.VirtualDrive' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDrive" } } }, "links": { "GetStorageVirtualDriveByMoid": { "operationId": "GetStorageVirtualDriveByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDrives/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveContainers": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveContainer' resource.", "operationId": "GetStorageVirtualDriveContainerList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDriveContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.VirtualDriveContainer' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveContainers/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveContainer' resource.", "operationId": "GetStorageVirtualDriveContainerByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only chassis", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDriveContainer", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.VirtualDriveContainer' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageVirtualDriveContainerByMoid": { "operationId": "GetStorageVirtualDriveContainerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveContainers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDriveContainer' resource.", "operationId": "UpdateStorageVirtualDriveContainer", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDriveContainer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDriveContainer' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveContainer' resource was modified as requested. The 'storage.VirtualDriveContainer' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } } }, "links": { "GetStorageVirtualDriveContainerByMoid": { "operationId": "GetStorageVirtualDriveContainerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveContainers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDriveContainer' resource.", "operationId": "PatchStorageVirtualDriveContainer", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDriveContainer" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDriveContainer' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveContainer' resource was patched as requested. The 'storage.VirtualDriveContainer' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } } }, "links": { "GetStorageVirtualDriveContainerByMoid": { "operationId": "GetStorageVirtualDriveContainerByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveContainers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveExtensions": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveExtension' resource.", "operationId": "GetStorageVirtualDriveExtensionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDriveExtension", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.VirtualDriveExtension' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveExtensions/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveExtension' resource.", "operationId": "GetStorageVirtualDriveExtensionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only servers", "PRIVSET.View Servers", "READ.storage.VirtualDriveExtension", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.VirtualDriveExtension' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageVirtualDriveExtensionByMoid": { "operationId": "GetStorageVirtualDriveExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDriveExtension' resource.", "operationId": "UpdateStorageVirtualDriveExtension", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDriveExtension" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDriveExtension' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveExtension' resource was modified as requested. The 'storage.VirtualDriveExtension' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } } }, "links": { "GetStorageVirtualDriveExtensionByMoid": { "operationId": "GetStorageVirtualDriveExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "storage" ], "summary": "Update a 'storage.VirtualDriveExtension' resource.", "operationId": "PatchStorageVirtualDriveExtension", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Servers", "ROLE.Account Administrator", "UPDATE.storage.VirtualDriveExtension" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'storage.VirtualDriveExtension' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'storage.VirtualDriveExtension' resource was patched as requested. The 'storage.VirtualDriveExtension' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } } }, "links": { "GetStorageVirtualDriveExtensionByMoid": { "operationId": "GetStorageVirtualDriveExtensionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveExtensions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveIdentities": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveIdentity' resource.", "operationId": "GetStorageVirtualDriveIdentityList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.VirtualDriveIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'storage.VirtualDriveIdentity' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveIdentity.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/storage/VirtualDriveIdentities/{Moid}": { "get": { "tags": [ "storage" ], "summary": "Read a 'storage.VirtualDriveIdentity' resource.", "operationId": "GetStorageVirtualDriveIdentityByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Storage policies", "PRIVSET.View Server Profiles", "READ.storage.VirtualDriveIdentity", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'storage.VirtualDriveIdentity' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storage.VirtualDriveIdentity" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetStorageVirtualDriveIdentityByMoid": { "operationId": "GetStorageVirtualDriveIdentityByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/storage/VirtualDriveIdentities/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/syslog/Policies": { "post": { "tags": [ "syslog" ], "summary": "Create a 'syslog.Policy' resource.", "operationId": "CreateSyslogPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.syslog.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Syslog policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'syslog.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'syslog.Policy' resource was created as requested. The 'syslog.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } } }, "links": { "GetSyslogPolicyByMoid": { "operationId": "GetSyslogPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "syslog" ], "summary": "Read a 'syslog.Policy' resource.", "operationId": "GetSyslogPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Syslog policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.syslog.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'syslog.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/syslog/Policies/{Moid}": { "get": { "tags": [ "syslog" ], "summary": "Read a 'syslog.Policy' resource.", "operationId": "GetSyslogPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Syslog policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.syslog.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'syslog.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSyslogPolicyByMoid": { "operationId": "GetSyslogPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "syslog" ], "summary": "Update a 'syslog.Policy' resource.", "operationId": "UpdateSyslogPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Syslog policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.syslog.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'syslog.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'syslog.Policy' resource was modified as requested. The 'syslog.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } } }, "links": { "GetSyslogPolicyByMoid": { "operationId": "GetSyslogPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "syslog" ], "summary": "Update a 'syslog.Policy' resource.", "operationId": "PatchSyslogPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Syslog policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.syslog.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'syslog.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'syslog.Policy' resource was patched as requested. The 'syslog.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.Policy" } } }, "links": { "GetSyslogPolicyByMoid": { "operationId": "GetSyslogPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "syslog" ], "summary": "Delete a 'syslog.Policy' resource.", "operationId": "DeleteSyslogPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.syslog.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Syslog policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/syslog/PolicyInventories": { "get": { "tags": [ "syslog" ], "summary": "Read a 'syslog.PolicyInventory' resource.", "operationId": "GetSyslogPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Syslog policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.syslog.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'syslog.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/syslog/PolicyInventories/{Moid}": { "get": { "tags": [ "syslog" ], "summary": "Read a 'syslog.PolicyInventory' resource.", "operationId": "GetSyslogPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Syslog policies", "PRIVSET.View Network Switches", "PRIVSET.View SAN Switches", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.syslog.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'syslog.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syslog.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetSyslogPolicyInventoryByMoid": { "operationId": "GetSyslogPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/syslog/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryCounts": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryCount' resource.", "operationId": "GetTamAdvisoryCountList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "READ.tam.AdvisoryCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'tam.AdvisoryCount' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryCount.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryCounts/{Moid}": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryCount' resource.", "operationId": "GetTamAdvisoryCountByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "READ.tam.AdvisoryCount", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'tam.AdvisoryCount' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryCount" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTamAdvisoryCountByMoid": { "operationId": "GetTamAdvisoryCountByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryCounts/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryDefinitions": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryDefinition' resource.", "operationId": "GetTamAdvisoryDefinitionList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'tam.AdvisoryDefinition' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryDefinition.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryDefinitions/{Moid}": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryDefinition' resource.", "operationId": "GetTamAdvisoryDefinitionByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryDefinition", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'tam.AdvisoryDefinition' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryDefinition" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTamAdvisoryDefinitionByMoid": { "operationId": "GetTamAdvisoryDefinitionByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryDefinitions/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryInfos": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryInfo' resource.", "operationId": "GetTamAdvisoryInfoList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'tam.AdvisoryInfo' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "tam" ], "summary": "Create a 'tam.AdvisoryInfo' resource.", "operationId": "CreateTamAdvisoryInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.tam.AdvisoryInfo", "PRIVSET.Account Administrator", "PRIVSET.Acknowledge advisories", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'tam.AdvisoryInfo' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was created as requested. The 'tam.AdvisoryInfo' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } } }, "links": { "GetTamAdvisoryInfoByMoid": { "operationId": "GetTamAdvisoryInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryInfos/{Moid}": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryInfo' resource.", "operationId": "GetTamAdvisoryInfoByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryInfo", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'tam.AdvisoryInfo' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTamAdvisoryInfoByMoid": { "operationId": "GetTamAdvisoryInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "tam" ], "summary": "Update a 'tam.AdvisoryInfo' resource.", "operationId": "UpdateTamAdvisoryInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Acknowledge advisories", "ROLE.Account Administrator", "UPDATE.tam.AdvisoryInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'tam.AdvisoryInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was modified as requested. The 'tam.AdvisoryInfo' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } } }, "links": { "GetTamAdvisoryInfoByMoid": { "operationId": "GetTamAdvisoryInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "tam" ], "summary": "Update a 'tam.AdvisoryInfo' resource.", "operationId": "PatchTamAdvisoryInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Acknowledge advisories", "ROLE.Account Administrator", "UPDATE.tam.AdvisoryInfo" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'tam.AdvisoryInfo' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'tam.AdvisoryInfo' resource was patched as requested. The 'tam.AdvisoryInfo' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInfo" } } }, "links": { "GetTamAdvisoryInfoByMoid": { "operationId": "GetTamAdvisoryInfoByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInfos/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "tam" ], "summary": "Delete a 'tam.AdvisoryInfo' resource.", "operationId": "DeleteTamAdvisoryInfo", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.tam.AdvisoryInfo", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryInstances": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryInstance' resource.", "operationId": "GetTamAdvisoryInstanceList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryInstance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'tam.AdvisoryInstance' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInstance.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/AdvisoryInstances/{Moid}": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.AdvisoryInstance' resource.", "operationId": "GetTamAdvisoryInstanceByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.AdvisoryInstance", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'tam.AdvisoryInstance' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.AdvisoryInstance" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTamAdvisoryInstanceByMoid": { "operationId": "GetTamAdvisoryInstanceByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/AdvisoryInstances/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/SecurityAdvisories": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.SecurityAdvisory' resource.", "operationId": "GetTamSecurityAdvisoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.SecurityAdvisory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'tam.SecurityAdvisory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.SecurityAdvisory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/tam/SecurityAdvisories/{Moid}": { "get": { "tags": [ "tam" ], "summary": "Read a 'tam.SecurityAdvisory' resource.", "operationId": "GetTamSecurityAdvisoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Fabric Interconnects", "PRIVSET.Manage HyperFlex Clusters", "PRIVSET.Manage Servers", "PRIVSET.Read-Only", "PRIVSET.Read-only all advisories", "PRIVSET.View Fabric Interconnects", "PRIVSET.View HyperFlex Clusters", "PRIVSET.View Servers", "READ.tam.SecurityAdvisory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'tam.SecurityAdvisory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tam.SecurityAdvisory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTamSecurityAdvisoryByMoid": { "operationId": "GetTamSecurityAdvisoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/tam/SecurityAdvisories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/terminal/AuditLogs": { "get": { "tags": [ "terminal" ], "summary": "Read a 'terminal.AuditLog' resource.", "operationId": "GetTerminalAuditLogList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.terminal.AuditLog" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'terminal.AuditLog' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.AuditLog.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/terminal/AuditLogs/{Moid}": { "get": { "tags": [ "terminal" ], "summary": "Read a 'terminal.AuditLog' resource.", "operationId": "GetTerminalAuditLogByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "READ.terminal.AuditLog" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'terminal.AuditLog' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/terminal.AuditLog" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetTerminalAuditLogByMoid": { "operationId": "GetTerminalAuditLogByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/terminal/AuditLogs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/thermal/Policies": { "get": { "tags": [ "thermal" ], "summary": "Read a 'thermal.Policy' resource.", "operationId": "GetThermalPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Thermal policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.thermal.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'thermal.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "thermal" ], "summary": "Create a 'thermal.Policy' resource.", "operationId": "CreateThermalPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.thermal.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Thermal policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'thermal.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'thermal.Policy' resource was created as requested. The 'thermal.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } } }, "links": { "GetThermalPolicyByMoid": { "operationId": "GetThermalPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/thermal/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/thermal/Policies/{Moid}": { "get": { "tags": [ "thermal" ], "summary": "Read a 'thermal.Policy' resource.", "operationId": "GetThermalPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Thermal policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.thermal.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'thermal.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetThermalPolicyByMoid": { "operationId": "GetThermalPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/thermal/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "thermal" ], "summary": "Update a 'thermal.Policy' resource.", "operationId": "UpdateThermalPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Thermal policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.thermal.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'thermal.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'thermal.Policy' resource was modified as requested. The 'thermal.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } } }, "links": { "GetThermalPolicyByMoid": { "operationId": "GetThermalPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/thermal/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "thermal" ], "summary": "Update a 'thermal.Policy' resource.", "operationId": "PatchThermalPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Thermal policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator", "UPDATE.thermal.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'thermal.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'thermal.Policy' resource was patched as requested. The 'thermal.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.Policy" } } }, "links": { "GetThermalPolicyByMoid": { "operationId": "GetThermalPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/thermal/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "thermal" ], "summary": "Delete a 'thermal.Policy' resource.", "operationId": "DeleteThermalPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.thermal.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Thermal policies", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/thermal/PolicyInventories": { "get": { "tags": [ "thermal" ], "summary": "Read a 'thermal.PolicyInventory' resource.", "operationId": "GetThermalPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Thermal policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.thermal.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'thermal.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/thermal/PolicyInventories/{Moid}": { "get": { "tags": [ "thermal" ], "summary": "Read a 'thermal.PolicyInventory' resource.", "operationId": "GetThermalPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Unified Edge Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Thermal policies", "PRIVSET.View Server Profiles", "PRIVSET.View Unified Edge Profiles", "READ.thermal.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'thermal.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/thermal.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetThermalPolicyInventoryByMoid": { "operationId": "GetThermalPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/thermal/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Blocks": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Block' resource.", "operationId": "GetUuidpoolBlockList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Block", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.Block' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Block.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Blocks/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Block' resource.", "operationId": "GetUuidpoolBlockByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Block", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.Block' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Block" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolBlockByMoid": { "operationId": "GetUuidpoolBlockByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Blocks/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Pools": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Pool' resource.", "operationId": "GetUuidpoolPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.Pool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "uuidpool" ], "summary": "Create a 'uuidpool.Pool' resource.", "operationId": "CreateUuidpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.uuidpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Create UUID pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'uuidpool.Pool' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Pool' resource was created as requested. The 'uuidpool.Pool' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } } }, "links": { "GetUuidpoolPoolByMoid": { "operationId": "GetUuidpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Pools/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Pool' resource.", "operationId": "GetUuidpoolPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Pool", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.Pool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolPoolByMoid": { "operationId": "GetUuidpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "uuidpool" ], "summary": "Update a 'uuidpool.Pool' resource.", "operationId": "UpdateUuidpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit UUID pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.uuidpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'uuidpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Pool' resource was modified as requested. The 'uuidpool.Pool' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } } }, "links": { "GetUuidpoolPoolByMoid": { "operationId": "GetUuidpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "uuidpool" ], "summary": "Update a 'uuidpool.Pool' resource.", "operationId": "PatchUuidpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit UUID pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator", "UPDATE.uuidpool.Pool" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'uuidpool.Pool' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Pool' resource was patched as requested. The 'uuidpool.Pool' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Pool" } } }, "links": { "GetUuidpoolPoolByMoid": { "operationId": "GetUuidpoolPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Pools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "uuidpool" ], "summary": "Delete a 'uuidpool.Pool' resource.", "operationId": "DeleteUuidpoolPool", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.uuidpool.Pool", "PRIVSET.Account Administrator", "PRIVSET.Delete UUID pools", "PRIVSET.Manage Switch Profiles", "PRIVSET.Server Administrator", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/PoolMembers": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.PoolMember' resource.", "operationId": "GetUuidpoolPoolMemberList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.PoolMember' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.PoolMember.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/PoolMembers/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.PoolMember' resource.", "operationId": "GetUuidpoolPoolMemberByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.PoolMember", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.PoolMember' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.PoolMember" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolPoolMemberByMoid": { "operationId": "GetUuidpoolPoolMemberByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/PoolMembers/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Reservations": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Reservation' resource.", "operationId": "GetUuidpoolReservationList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.Reservation' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Reservation.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "uuidpool" ], "summary": "Create a 'uuidpool.Reservation' resource.", "operationId": "CreateUuidpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.uuidpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Create UUID pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'uuidpool.Reservation' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Reservation" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'uuidpool.Reservation' resource was created as requested. The 'uuidpool.Reservation' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Reservation" } } }, "links": { "GetUuidpoolReservationByMoid": { "operationId": "GetUuidpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Reservations/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Reservation' resource.", "operationId": "GetUuidpoolReservationByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Reservation", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.Reservation' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Reservation" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolReservationByMoid": { "operationId": "GetUuidpoolReservationByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Reservations/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "uuidpool" ], "summary": "Delete a 'uuidpool.Reservation' resource.", "operationId": "DeleteUuidpoolReservation", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.uuidpool.Reservation", "PRIVSET.Account Administrator", "PRIVSET.Delete UUID pool address reservations", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Universes": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Universe' resource.", "operationId": "GetUuidpoolUniverseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.Universe' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Universe.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/Universes/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.Universe' resource.", "operationId": "GetUuidpoolUniverseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.Universe", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.Universe' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.Universe" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolUniverseByMoid": { "operationId": "GetUuidpoolUniverseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/Universes/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/UuidLeases": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.UuidLease' resource.", "operationId": "GetUuidpoolUuidLeaseList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.UuidLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'uuidpool.UuidLease' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.UuidLease.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/uuidpool/UuidLeases/{Moid}": { "get": { "tags": [ "uuidpool" ], "summary": "Read a 'uuidpool.UuidLease' resource.", "operationId": "GetUuidpoolUuidLeaseByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UUID pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.uuidpool.UuidLease", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'uuidpool.UuidLease' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uuidpool.UuidLease" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetUuidpoolUuidLeaseByMoid": { "operationId": "GetUuidpoolUuidLeaseByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/uuidpool/UuidLeases/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "uuidpool" ], "summary": "Delete a 'uuidpool.UuidLease' resource.", "operationId": "DeleteUuidpoolUuidLease", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.uuidpool.UuidLease", "PRIVSET.Account Administrator", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vmedia/Policies": { "post": { "tags": [ "vmedia" ], "summary": "Create a 'vmedia.Policy' resource.", "operationId": "CreateVmediaPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vmedia.Policy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Virtual Media policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vmedia.Policy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vmedia.Policy' resource was created as requested. The 'vmedia.Policy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } } }, "links": { "GetVmediaPolicyByMoid": { "operationId": "GetVmediaPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "get": { "tags": [ "vmedia" ], "summary": "Read a 'vmedia.Policy' resource.", "operationId": "GetVmediaPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vMedia policies", "PRIVSET.View Server Profiles", "READ.vmedia.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vmedia.Policy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vmedia/Policies/{Moid}": { "get": { "tags": [ "vmedia" ], "summary": "Read a 'vmedia.Policy' resource.", "operationId": "GetVmediaPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vMedia policies", "PRIVSET.View Server Profiles", "READ.vmedia.Policy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vmedia.Policy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVmediaPolicyByMoid": { "operationId": "GetVmediaPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vmedia" ], "summary": "Update a 'vmedia.Policy' resource.", "operationId": "UpdateVmediaPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Virtual Media policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vmedia.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vmedia.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vmedia.Policy' resource was modified as requested. The 'vmedia.Policy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } } }, "links": { "GetVmediaPolicyByMoid": { "operationId": "GetVmediaPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vmedia" ], "summary": "Update a 'vmedia.Policy' resource.", "operationId": "PatchVmediaPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Virtual Media policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vmedia.Policy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vmedia.Policy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vmedia.Policy' resource was patched as requested. The 'vmedia.Policy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.Policy" } } }, "links": { "GetVmediaPolicyByMoid": { "operationId": "GetVmediaPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/Policies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vmedia" ], "summary": "Delete a 'vmedia.Policy' resource.", "operationId": "DeleteVmediaPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vmedia.Policy", "PRIVSET.Account Administrator", "PRIVSET.Delete Virtual Media policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vmedia/PolicyInventories": { "get": { "tags": [ "vmedia" ], "summary": "Read a 'vmedia.PolicyInventory' resource.", "operationId": "GetVmediaPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vMedia policies", "PRIVSET.View Server Profiles", "READ.vmedia.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vmedia.PolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.PolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vmedia/PolicyInventories/{Moid}": { "get": { "tags": [ "vmedia" ], "summary": "Read a 'vmedia.PolicyInventory' resource.", "operationId": "GetVmediaPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vMedia policies", "PRIVSET.View Server Profiles", "READ.vmedia.PolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vmedia.PolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vmedia.PolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVmediaPolicyInventoryByMoid": { "operationId": "GetVmediaPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vmedia/PolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthAdapterPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthAdapterPolicy' resource.", "operationId": "GetVnicEthAdapterPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.EthAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthAdapterPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.EthAdapterPolicy' resource.", "operationId": "CreateVnicEthAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.EthAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Ethernet Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.EthAdapterPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was created as requested. The 'vnic.EthAdapterPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } } }, "links": { "GetVnicEthAdapterPolicyByMoid": { "operationId": "GetVnicEthAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthAdapterPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthAdapterPolicy' resource.", "operationId": "GetVnicEthAdapterPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.EthAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthAdapterPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthAdapterPolicyByMoid": { "operationId": "GetVnicEthAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthAdapterPolicy' resource.", "operationId": "UpdateVnicEthAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was modified as requested. The 'vnic.EthAdapterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } } }, "links": { "GetVnicEthAdapterPolicyByMoid": { "operationId": "GetVnicEthAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthAdapterPolicy' resource.", "operationId": "PatchVnicEthAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthAdapterPolicy' resource was patched as requested. The 'vnic.EthAdapterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } } }, "links": { "GetVnicEthAdapterPolicyByMoid": { "operationId": "GetVnicEthAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.EthAdapterPolicy' resource.", "operationId": "DeleteVnicEthAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.EthAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Ethernet Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthAdapterPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthAdapterPolicyInventory' resource.", "operationId": "GetVnicEthAdapterPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.EthAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthAdapterPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthAdapterPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthAdapterPolicyInventory' resource.", "operationId": "GetVnicEthAdapterPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.EthAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthAdapterPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthAdapterPolicyInventoryByMoid": { "operationId": "GetVnicEthAdapterPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthAdapterPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthIfs": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthIf' resource.", "operationId": "GetVnicEthIfList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.EthIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthIf' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.EthIf' resource.", "operationId": "CreateVnicEthIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.EthIf", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LAN Connectivity policies", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.EthIf' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was created as requested. The 'vnic.EthIf' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } } }, "links": { "GetVnicEthIfByMoid": { "operationId": "GetVnicEthIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthIfs/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthIf' resource.", "operationId": "GetVnicEthIfByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.EthIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthIf' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthIfByMoid": { "operationId": "GetVnicEthIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthIf' resource.", "operationId": "UpdateVnicEthIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LAN Connectivity policies", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthIf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthIf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was modified as requested. The 'vnic.EthIf' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } } }, "links": { "GetVnicEthIfByMoid": { "operationId": "GetVnicEthIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthIf' resource.", "operationId": "PatchVnicEthIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LAN Connectivity policies", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthIf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthIf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthIf' resource was patched as requested. The 'vnic.EthIf' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIf" } } }, "links": { "GetVnicEthIfByMoid": { "operationId": "GetVnicEthIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.EthIf' resource.", "operationId": "DeleteVnicEthIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.EthIf", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LAN Connectivity policies", "PRIVSET.Delete LAN Connectivity policies", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthIfInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthIfInventory' resource.", "operationId": "GetVnicEthIfInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.EthIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthIfInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIfInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthIfInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthIfInventory' resource.", "operationId": "GetVnicEthIfInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.EthIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthIfInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthIfInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthIfInventoryByMoid": { "operationId": "GetVnicEthIfInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthIfInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthNetworkPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthNetworkPolicy' resource.", "operationId": "GetVnicEthNetworkPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Network policies", "PRIVSET.View Server Profiles", "READ.vnic.EthNetworkPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthNetworkPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.EthNetworkPolicy' resource.", "operationId": "CreateVnicEthNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.EthNetworkPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Ethernet Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.EthNetworkPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was created as requested. The 'vnic.EthNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } } }, "links": { "GetVnicEthNetworkPolicyByMoid": { "operationId": "GetVnicEthNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthNetworkPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthNetworkPolicy' resource.", "operationId": "GetVnicEthNetworkPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Network policies", "PRIVSET.View Server Profiles", "READ.vnic.EthNetworkPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthNetworkPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthNetworkPolicyByMoid": { "operationId": "GetVnicEthNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthNetworkPolicy' resource.", "operationId": "UpdateVnicEthNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthNetworkPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthNetworkPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was modified as requested. The 'vnic.EthNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } } }, "links": { "GetVnicEthNetworkPolicyByMoid": { "operationId": "GetVnicEthNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthNetworkPolicy' resource.", "operationId": "PatchVnicEthNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthNetworkPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthNetworkPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthNetworkPolicy' resource was patched as requested. The 'vnic.EthNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } } }, "links": { "GetVnicEthNetworkPolicyByMoid": { "operationId": "GetVnicEthNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.EthNetworkPolicy' resource.", "operationId": "DeleteVnicEthNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.EthNetworkPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Ethernet Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthNetworkPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthNetworkPolicyInventory' resource.", "operationId": "GetVnicEthNetworkPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Network policies", "PRIVSET.View Server Profiles", "READ.vnic.EthNetworkPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthNetworkPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthNetworkPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthNetworkPolicyInventory' resource.", "operationId": "GetVnicEthNetworkPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet Network policies", "PRIVSET.View Server Profiles", "READ.vnic.EthNetworkPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthNetworkPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthNetworkPolicyInventoryByMoid": { "operationId": "GetVnicEthNetworkPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthNetworkPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthQosPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthQosPolicy' resource.", "operationId": "GetVnicEthQosPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.EthQosPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthQosPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.EthQosPolicy' resource.", "operationId": "CreateVnicEthQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.EthQosPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Ethernet QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.EthQosPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was created as requested. The 'vnic.EthQosPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } } }, "links": { "GetVnicEthQosPolicyByMoid": { "operationId": "GetVnicEthQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthQosPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthQosPolicy' resource.", "operationId": "GetVnicEthQosPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.EthQosPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthQosPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthQosPolicyByMoid": { "operationId": "GetVnicEthQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthQosPolicy' resource.", "operationId": "UpdateVnicEthQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthQosPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthQosPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was modified as requested. The 'vnic.EthQosPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } } }, "links": { "GetVnicEthQosPolicyByMoid": { "operationId": "GetVnicEthQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.EthQosPolicy' resource.", "operationId": "PatchVnicEthQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Ethernet QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.EthQosPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.EthQosPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.EthQosPolicy' resource was patched as requested. The 'vnic.EthQosPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicy" } } }, "links": { "GetVnicEthQosPolicyByMoid": { "operationId": "GetVnicEthQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.EthQosPolicy' resource.", "operationId": "DeleteVnicEthQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.EthQosPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Ethernet QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthQosPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthQosPolicyInventory' resource.", "operationId": "GetVnicEthQosPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.EthQosPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthQosPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthQosPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthQosPolicyInventory' resource.", "operationId": "GetVnicEthQosPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Ethernet QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.EthQosPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthQosPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthQosPolicyInventoryByMoid": { "operationId": "GetVnicEthQosPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthQosPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthVethInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthVethInventory' resource.", "operationId": "GetVnicEthVethInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.EthVethInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthVethInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthVethInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthVethInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthVethInventory' resource.", "operationId": "GetVnicEthVethInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.EthVethInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthVethInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthVethInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthVethInventoryByMoid": { "operationId": "GetVnicEthVethInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthVethInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthVnicInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthVnicInventory' resource.", "operationId": "GetVnicEthVnicInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.EthVnicInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.EthVnicInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthVnicInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/EthVnicInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.EthVnicInventory' resource.", "operationId": "GetVnicEthVnicInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.EthVnicInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.EthVnicInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.EthVnicInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicEthVnicInventoryByMoid": { "operationId": "GetVnicEthVnicInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/EthVnicInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcAdapterPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcAdapterPolicy' resource.", "operationId": "GetVnicFcAdapterPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.FcAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcAdapterPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.FcAdapterPolicy' resource.", "operationId": "CreateVnicFcAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.FcAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Fibre Channel Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.FcAdapterPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was created as requested. The 'vnic.FcAdapterPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } } }, "links": { "GetVnicFcAdapterPolicyByMoid": { "operationId": "GetVnicFcAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcAdapterPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcAdapterPolicy' resource.", "operationId": "GetVnicFcAdapterPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.FcAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcAdapterPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcAdapterPolicyByMoid": { "operationId": "GetVnicFcAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcAdapterPolicy' resource.", "operationId": "UpdateVnicFcAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was modified as requested. The 'vnic.FcAdapterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } } }, "links": { "GetVnicFcAdapterPolicyByMoid": { "operationId": "GetVnicFcAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcAdapterPolicy' resource.", "operationId": "PatchVnicFcAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcAdapterPolicy' resource was patched as requested. The 'vnic.FcAdapterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } } }, "links": { "GetVnicFcAdapterPolicyByMoid": { "operationId": "GetVnicFcAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.FcAdapterPolicy' resource.", "operationId": "DeleteVnicFcAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.FcAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Fibre Channel Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcAdapterPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcAdapterPolicyInventory' resource.", "operationId": "GetVnicFcAdapterPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.FcAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcAdapterPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcAdapterPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcAdapterPolicyInventory' resource.", "operationId": "GetVnicFcAdapterPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.FcAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcAdapterPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcAdapterPolicyInventoryByMoid": { "operationId": "GetVnicFcAdapterPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcAdapterPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcIfs": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcIf' resource.", "operationId": "GetVnicFcIfList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.FcIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcIf' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.FcIf' resource.", "operationId": "CreateVnicFcIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.FcIf", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SAN Connectivity policies", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.FcIf' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was created as requested. The 'vnic.FcIf' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } } }, "links": { "GetVnicFcIfByMoid": { "operationId": "GetVnicFcIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcIfs/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcIf' resource.", "operationId": "GetVnicFcIfByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.FcIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcIf' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcIfByMoid": { "operationId": "GetVnicFcIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcIf' resource.", "operationId": "UpdateVnicFcIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SAN Connectivity policies", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcIf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcIf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was modified as requested. The 'vnic.FcIf' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } } }, "links": { "GetVnicFcIfByMoid": { "operationId": "GetVnicFcIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcIf' resource.", "operationId": "PatchVnicFcIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SAN Connectivity policies", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcIf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcIf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcIf' resource was patched as requested. The 'vnic.FcIf' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIf" } } }, "links": { "GetVnicFcIfByMoid": { "operationId": "GetVnicFcIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.FcIf' resource.", "operationId": "DeleteVnicFcIf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.FcIf", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SAN Connectivity policies", "PRIVSET.Delete SAN Connectivity policies", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcIfInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcIfInventory' resource.", "operationId": "GetVnicFcIfInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.FcIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcIfInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIfInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcIfInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcIfInventory' resource.", "operationId": "GetVnicFcIfInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.FcIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcIfInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcIfInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcIfInventoryByMoid": { "operationId": "GetVnicFcIfInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcIfInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcNetworkPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcNetworkPolicy' resource.", "operationId": "GetVnicFcNetworkPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Network policies", "PRIVSET.View Server Profiles", "READ.vnic.FcNetworkPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcNetworkPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.FcNetworkPolicy' resource.", "operationId": "CreateVnicFcNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.FcNetworkPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Fibre Channel Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.FcNetworkPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was created as requested. The 'vnic.FcNetworkPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } } }, "links": { "GetVnicFcNetworkPolicyByMoid": { "operationId": "GetVnicFcNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcNetworkPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcNetworkPolicy' resource.", "operationId": "GetVnicFcNetworkPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Network policies", "PRIVSET.View Server Profiles", "READ.vnic.FcNetworkPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcNetworkPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcNetworkPolicyByMoid": { "operationId": "GetVnicFcNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcNetworkPolicy' resource.", "operationId": "UpdateVnicFcNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcNetworkPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcNetworkPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was modified as requested. The 'vnic.FcNetworkPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } } }, "links": { "GetVnicFcNetworkPolicyByMoid": { "operationId": "GetVnicFcNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcNetworkPolicy' resource.", "operationId": "PatchVnicFcNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcNetworkPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcNetworkPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcNetworkPolicy' resource was patched as requested. The 'vnic.FcNetworkPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } } }, "links": { "GetVnicFcNetworkPolicyByMoid": { "operationId": "GetVnicFcNetworkPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.FcNetworkPolicy' resource.", "operationId": "DeleteVnicFcNetworkPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.FcNetworkPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Fibre Channel Network policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcNetworkPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcNetworkPolicyInventory' resource.", "operationId": "GetVnicFcNetworkPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Network policies", "PRIVSET.View Server Profiles", "READ.vnic.FcNetworkPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcNetworkPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcNetworkPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcNetworkPolicyInventory' resource.", "operationId": "GetVnicFcNetworkPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel Network policies", "PRIVSET.View Server Profiles", "READ.vnic.FcNetworkPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcNetworkPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcNetworkPolicyInventoryByMoid": { "operationId": "GetVnicFcNetworkPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcNetworkPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcQosPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcQosPolicy' resource.", "operationId": "GetVnicFcQosPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.FcQosPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcQosPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.FcQosPolicy' resource.", "operationId": "CreateVnicFcQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.FcQosPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit Fibre Channel QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.FcQosPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was created as requested. The 'vnic.FcQosPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } } }, "links": { "GetVnicFcQosPolicyByMoid": { "operationId": "GetVnicFcQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcQosPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcQosPolicy' resource.", "operationId": "GetVnicFcQosPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.FcQosPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcQosPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcQosPolicyByMoid": { "operationId": "GetVnicFcQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcQosPolicy' resource.", "operationId": "UpdateVnicFcQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcQosPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcQosPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was modified as requested. The 'vnic.FcQosPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } } }, "links": { "GetVnicFcQosPolicyByMoid": { "operationId": "GetVnicFcQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.FcQosPolicy' resource.", "operationId": "PatchVnicFcQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit Fibre Channel QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.FcQosPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.FcQosPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.FcQosPolicy' resource was patched as requested. The 'vnic.FcQosPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicy" } } }, "links": { "GetVnicFcQosPolicyByMoid": { "operationId": "GetVnicFcQosPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.FcQosPolicy' resource.", "operationId": "DeleteVnicFcQosPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.FcQosPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete Fibre Channel QoS policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcQosPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcQosPolicyInventory' resource.", "operationId": "GetVnicFcQosPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.FcQosPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcQosPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcQosPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcQosPolicyInventory' resource.", "operationId": "GetVnicFcQosPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only Fibre Channel QoS policies", "PRIVSET.View Server Profiles", "READ.vnic.FcQosPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcQosPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcQosPolicyInventoryByMoid": { "operationId": "GetVnicFcQosPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcQosPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcVethInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcVethInventory' resource.", "operationId": "GetVnicFcVethInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.FcVethInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcVethInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcVethInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcVethInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcVethInventory' resource.", "operationId": "GetVnicFcVethInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.FcVethInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcVethInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcVethInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcVethInventoryByMoid": { "operationId": "GetVnicFcVethInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcVethInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcVhbaPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcVhbaPolicyInventory' resource.", "operationId": "GetVnicFcVhbaPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.FcVhbaPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.FcVhbaPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcVhbaPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/FcVhbaPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.FcVhbaPolicyInventory' resource.", "operationId": "GetVnicFcVhbaPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.FcVhbaPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.FcVhbaPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.FcVhbaPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicFcVhbaPolicyInventoryByMoid": { "operationId": "GetVnicFcVhbaPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/FcVhbaPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiAdapterPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "GetVnicIscsiAdapterPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiAdapterPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "CreateVnicIscsiAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.IscsiAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit iSCSI Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.IscsiAdapterPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiAdapterPolicy' resource was created as requested. The 'vnic.IscsiAdapterPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } } }, "links": { "GetVnicIscsiAdapterPolicyByMoid": { "operationId": "GetVnicIscsiAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiAdapterPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "GetVnicIscsiAdapterPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiAdapterPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiAdapterPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiAdapterPolicyByMoid": { "operationId": "GetVnicIscsiAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "UpdateVnicIscsiAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiAdapterPolicy' resource was modified as requested. The 'vnic.IscsiAdapterPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } } }, "links": { "GetVnicIscsiAdapterPolicyByMoid": { "operationId": "GetVnicIscsiAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "PatchVnicIscsiAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiAdapterPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiAdapterPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiAdapterPolicy' resource was patched as requested. The 'vnic.IscsiAdapterPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } } }, "links": { "GetVnicIscsiAdapterPolicyByMoid": { "operationId": "GetVnicIscsiAdapterPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiAdapterPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.IscsiAdapterPolicy' resource.", "operationId": "DeleteVnicIscsiAdapterPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.IscsiAdapterPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete iSCSI Adapter policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiAdapterPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiAdapterPolicyInventory' resource.", "operationId": "GetVnicIscsiAdapterPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiAdapterPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiAdapterPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiAdapterPolicyInventory' resource.", "operationId": "GetVnicIscsiAdapterPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Adapter policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiAdapterPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiAdapterPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiAdapterPolicyInventoryByMoid": { "operationId": "GetVnicIscsiAdapterPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiAdapterPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiBootPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiBootPolicy' resource.", "operationId": "GetVnicIscsiBootPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Boot policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiBootPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiBootPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.IscsiBootPolicy' resource.", "operationId": "CreateVnicIscsiBootPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.IscsiBootPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit iSCSI Boot policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.IscsiBootPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiBootPolicy' resource was created as requested. The 'vnic.IscsiBootPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } } }, "links": { "GetVnicIscsiBootPolicyByMoid": { "operationId": "GetVnicIscsiBootPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiBootPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiBootPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiBootPolicy' resource.", "operationId": "GetVnicIscsiBootPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Boot policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiBootPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiBootPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiBootPolicyByMoid": { "operationId": "GetVnicIscsiBootPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiBootPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiBootPolicy' resource.", "operationId": "UpdateVnicIscsiBootPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Boot policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiBootPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiBootPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiBootPolicy' resource was modified as requested. The 'vnic.IscsiBootPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } } }, "links": { "GetVnicIscsiBootPolicyByMoid": { "operationId": "GetVnicIscsiBootPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiBootPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiBootPolicy' resource.", "operationId": "PatchVnicIscsiBootPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Boot policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiBootPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiBootPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiBootPolicy' resource was patched as requested. The 'vnic.IscsiBootPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } } }, "links": { "GetVnicIscsiBootPolicyByMoid": { "operationId": "GetVnicIscsiBootPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiBootPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.IscsiBootPolicy' resource.", "operationId": "DeleteVnicIscsiBootPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.IscsiBootPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete iSCSI Boot policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiBootPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiBootPolicyInventory' resource.", "operationId": "GetVnicIscsiBootPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Boot policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiBootPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiBootPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiBootPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiBootPolicyInventory' resource.", "operationId": "GetVnicIscsiBootPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Boot policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiBootPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiBootPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiBootPolicyInventoryByMoid": { "operationId": "GetVnicIscsiBootPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiBootPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiStaticTargetPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "GetVnicIscsiStaticTargetPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Static Target policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiStaticTargetPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiStaticTargetPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "CreateVnicIscsiStaticTargetPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.IscsiStaticTargetPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit iSCSI Static Target policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.IscsiStaticTargetPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiStaticTargetPolicy' resource was created as requested. The 'vnic.IscsiStaticTargetPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } } }, "links": { "GetVnicIscsiStaticTargetPolicyByMoid": { "operationId": "GetVnicIscsiStaticTargetPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiStaticTargetPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiStaticTargetPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "GetVnicIscsiStaticTargetPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Static Target policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiStaticTargetPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiStaticTargetPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiStaticTargetPolicyByMoid": { "operationId": "GetVnicIscsiStaticTargetPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiStaticTargetPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "UpdateVnicIscsiStaticTargetPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Static Target policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiStaticTargetPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiStaticTargetPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiStaticTargetPolicy' resource was modified as requested. The 'vnic.IscsiStaticTargetPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } } }, "links": { "GetVnicIscsiStaticTargetPolicyByMoid": { "operationId": "GetVnicIscsiStaticTargetPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiStaticTargetPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "PatchVnicIscsiStaticTargetPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit iSCSI Static Target policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.IscsiStaticTargetPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.IscsiStaticTargetPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.IscsiStaticTargetPolicy' resource was patched as requested. The 'vnic.IscsiStaticTargetPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } } }, "links": { "GetVnicIscsiStaticTargetPolicyByMoid": { "operationId": "GetVnicIscsiStaticTargetPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiStaticTargetPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.IscsiStaticTargetPolicy' resource.", "operationId": "DeleteVnicIscsiStaticTargetPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.IscsiStaticTargetPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete iSCSI Static Target policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiStaticTargetPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiStaticTargetPolicyInventory' resource.", "operationId": "GetVnicIscsiStaticTargetPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Static Target policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiStaticTargetPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.IscsiStaticTargetPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/IscsiStaticTargetPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.IscsiStaticTargetPolicyInventory' resource.", "operationId": "GetVnicIscsiStaticTargetPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only iSCSI Static Target policies", "PRIVSET.View Server Profiles", "READ.vnic.IscsiStaticTargetPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.IscsiStaticTargetPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicIscsiStaticTargetPolicyInventoryByMoid": { "operationId": "GetVnicIscsiStaticTargetPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/IscsiStaticTargetPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanConnectivityPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanConnectivityPolicy' resource.", "operationId": "GetVnicLanConnectivityPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.LanConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.LanConnectivityPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.LanConnectivityPolicy' resource.", "operationId": "CreateVnicLanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.LanConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.LanConnectivityPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was created as requested. The 'vnic.LanConnectivityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } } }, "links": { "GetVnicLanConnectivityPolicyByMoid": { "operationId": "GetVnicLanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanConnectivityPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanConnectivityPolicy' resource.", "operationId": "GetVnicLanConnectivityPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.LanConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.LanConnectivityPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicLanConnectivityPolicyByMoid": { "operationId": "GetVnicLanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.LanConnectivityPolicy' resource.", "operationId": "UpdateVnicLanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.LanConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.LanConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was modified as requested. The 'vnic.LanConnectivityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } } }, "links": { "GetVnicLanConnectivityPolicyByMoid": { "operationId": "GetVnicLanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.LanConnectivityPolicy' resource.", "operationId": "PatchVnicLanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.LanConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.LanConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.LanConnectivityPolicy' resource was patched as requested. The 'vnic.LanConnectivityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } } }, "links": { "GetVnicLanConnectivityPolicyByMoid": { "operationId": "GetVnicLanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.LanConnectivityPolicy' resource.", "operationId": "DeleteVnicLanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.LanConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete LAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanConnectivityPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanConnectivityPolicyInventory' resource.", "operationId": "GetVnicLanConnectivityPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.LanConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.LanConnectivityPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanConnectivityPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanConnectivityPolicyInventory' resource.", "operationId": "GetVnicLanConnectivityPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only LAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.LanConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.LanConnectivityPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicLanConnectivityPolicyInventoryByMoid": { "operationId": "GetVnicLanConnectivityPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanConnectivityPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanSettings": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanSettings' resource.", "operationId": "GetVnicLanSettingsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.LanSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.LanSettings' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanSettings.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LanSettings/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LanSettings' resource.", "operationId": "GetVnicLanSettingsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.LanSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.LanSettings' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LanSettings" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicLanSettingsByMoid": { "operationId": "GetVnicLanSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LanSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LcpStatuses": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LcpStatus' resource.", "operationId": "GetVnicLcpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.LcpStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.LcpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LcpStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/LcpStatuses/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.LcpStatus' resource.", "operationId": "GetVnicLcpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.LcpStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.LcpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.LcpStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicLcpStatusByMoid": { "operationId": "GetVnicLcpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/LcpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanConnectivityPolicies": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanConnectivityPolicy' resource.", "operationId": "GetVnicSanConnectivityPolicyList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.SanConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.SanConnectivityPolicy' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.SanConnectivityPolicy' resource.", "operationId": "CreateVnicSanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.SanConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Create, clone and edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.SanConnectivityPolicy' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was created as requested. The 'vnic.SanConnectivityPolicy' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } } }, "links": { "GetVnicSanConnectivityPolicyByMoid": { "operationId": "GetVnicSanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanConnectivityPolicies/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanConnectivityPolicy' resource.", "operationId": "GetVnicSanConnectivityPolicyByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.SanConnectivityPolicy", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.SanConnectivityPolicy' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicSanConnectivityPolicyByMoid": { "operationId": "GetVnicSanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.SanConnectivityPolicy' resource.", "operationId": "UpdateVnicSanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.SanConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.SanConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was modified as requested. The 'vnic.SanConnectivityPolicy' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } } }, "links": { "GetVnicSanConnectivityPolicyByMoid": { "operationId": "GetVnicSanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.SanConnectivityPolicy' resource.", "operationId": "PatchVnicSanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Edit SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.SanConnectivityPolicy" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.SanConnectivityPolicy' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.SanConnectivityPolicy' resource was patched as requested. The 'vnic.SanConnectivityPolicy' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } } }, "links": { "GetVnicSanConnectivityPolicyByMoid": { "operationId": "GetVnicSanConnectivityPolicyByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicies/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.SanConnectivityPolicy' resource.", "operationId": "DeleteVnicSanConnectivityPolicy", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.SanConnectivityPolicy", "PRIVSET.Account Administrator", "PRIVSET.Delete SAN Connectivity policies", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanConnectivityPolicyInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanConnectivityPolicyInventory' resource.", "operationId": "GetVnicSanConnectivityPolicyInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.SanConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.SanConnectivityPolicyInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanConnectivityPolicyInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanConnectivityPolicyInventory' resource.", "operationId": "GetVnicSanConnectivityPolicyInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only SAN Connectivity policies", "PRIVSET.View Server Profiles", "READ.vnic.SanConnectivityPolicyInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.SanConnectivityPolicyInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicSanConnectivityPolicyInventoryByMoid": { "operationId": "GetVnicSanConnectivityPolicyInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanConnectivityPolicyInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanSettings": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanSettings' resource.", "operationId": "GetVnicSanSettingsList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.SanSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.SanSettings' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanSettings.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/SanSettings/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.SanSettings' resource.", "operationId": "GetVnicSanSettingsByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.SanSettings", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.SanSettings' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.SanSettings" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicSanSettingsByMoid": { "operationId": "GetVnicSanSettingsByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/SanSettings/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ScpStatuses": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ScpStatus' resource.", "operationId": "GetVnicScpStatusList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.ScpStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.ScpStatus' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ScpStatus.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ScpStatuses/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ScpStatus' resource.", "operationId": "GetVnicScpStatusByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only UCS server profiles", "PRIVSET.View Server Profiles", "READ.vnic.ScpStatus", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.ScpStatus' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ScpStatus" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicScpStatusByMoid": { "operationId": "GetVnicScpStatusByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/ScpStatuses/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ServiceEthIfs": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ServiceEthIf' resource.", "operationId": "GetVnicServiceEthIfList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.vnic.ServiceEthIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.ServiceEthIf' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ServiceEthIf.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ServiceEthIfs/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ServiceEthIf' resource.", "operationId": "GetVnicServiceEthIfByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.vnic.ServiceEthIf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.ServiceEthIf' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ServiceEthIf" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicServiceEthIfByMoid": { "operationId": "GetVnicServiceEthIfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/ServiceEthIfs/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ServiceEthIfInventories": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ServiceEthIfInventory' resource.", "operationId": "GetVnicServiceEthIfInventoryList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.vnic.ServiceEthIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.ServiceEthIfInventory' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ServiceEthIfInventory.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/ServiceEthIfInventories/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.ServiceEthIfInventory' resource.", "operationId": "GetVnicServiceEthIfInventoryByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.View Server Profiles", "READ.vnic.ServiceEthIfInventory", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.ServiceEthIfInventory' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.ServiceEthIfInventory" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicServiceEthIfInventoryByMoid": { "operationId": "GetVnicServiceEthIfInventoryByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/ServiceEthIfInventories/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VhbaTemplates": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VhbaTemplate' resource.", "operationId": "GetVnicVhbaTemplateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vHBA templates", "PRIVSET.View Server Profiles", "READ.vnic.VhbaTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.VhbaTemplate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.VhbaTemplate' resource.", "operationId": "CreateVnicVhbaTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.VhbaTemplate", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.VhbaTemplate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VhbaTemplate' resource was created as requested. The 'vnic.VhbaTemplate' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } } }, "links": { "GetVnicVhbaTemplateByMoid": { "operationId": "GetVnicVhbaTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VhbaTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VhbaTemplates/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VhbaTemplate' resource.", "operationId": "GetVnicVhbaTemplateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vHBA templates", "PRIVSET.View Server Profiles", "READ.vnic.VhbaTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.VhbaTemplate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicVhbaTemplateByMoid": { "operationId": "GetVnicVhbaTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VhbaTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.VhbaTemplate' resource.", "operationId": "UpdateVnicVhbaTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.VhbaTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.VhbaTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VhbaTemplate' resource was modified as requested. The 'vnic.VhbaTemplate' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } } }, "links": { "GetVnicVhbaTemplateByMoid": { "operationId": "GetVnicVhbaTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VhbaTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.VhbaTemplate' resource.", "operationId": "PatchVnicVhbaTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.VhbaTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.VhbaTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VhbaTemplate' resource was patched as requested. The 'vnic.VhbaTemplate' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VhbaTemplate" } } }, "links": { "GetVnicVhbaTemplateByMoid": { "operationId": "GetVnicVhbaTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VhbaTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.VhbaTemplate' resource.", "operationId": "DeleteVnicVhbaTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.VhbaTemplate", "PRIVSET.Account Administrator", "PRIVSET.Delete vHBA templates", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VifIdPools": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VifIdPool' resource.", "operationId": "GetVnicVifIdPoolList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only vHBA templates", "PRIVSET.Read-only vNIC templates", "PRIVSET.Server Administrator", "READ.vnic.VifIdPool", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.VifIdPool' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VifIdPool.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VifIdPools/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VifIdPool' resource.", "operationId": "GetVnicVifIdPoolByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Read-only vHBA templates", "PRIVSET.Read-only vNIC templates", "PRIVSET.Server Administrator", "READ.vnic.VifIdPool", "ROLE.Account Administrator", "ROLE.Server Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.VifIdPool' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VifIdPool" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicVifIdPoolByMoid": { "operationId": "GetVnicVifIdPoolByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VifIdPools/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VnicTemplates": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VnicTemplate' resource.", "operationId": "GetVnicVnicTemplateList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vNIC templates", "PRIVSET.View Server Profiles", "READ.vnic.VnicTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vnic.VnicTemplate' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Create a 'vnic.VnicTemplate' resource.", "operationId": "CreateVnicVnicTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vnic.VnicTemplate", "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vnic.VnicTemplate' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VnicTemplate' resource was created as requested. The 'vnic.VnicTemplate' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } } }, "links": { "GetVnicVnicTemplateByMoid": { "operationId": "GetVnicVnicTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VnicTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vnic/VnicTemplates/{Moid}": { "get": { "tags": [ "vnic" ], "summary": "Read a 'vnic.VnicTemplate' resource.", "operationId": "GetVnicVnicTemplateByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only vNIC templates", "PRIVSET.View Server Profiles", "READ.vnic.VnicTemplate", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vnic.VnicTemplate' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVnicVnicTemplateByMoid": { "operationId": "GetVnicVnicTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VnicTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vnic" ], "summary": "Update a 'vnic.VnicTemplate' resource.", "operationId": "UpdateVnicVnicTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.VnicTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.VnicTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VnicTemplate' resource was modified as requested. The 'vnic.VnicTemplate' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } } }, "links": { "GetVnicVnicTemplateByMoid": { "operationId": "GetVnicVnicTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VnicTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vnic" ], "summary": "Update a 'vnic.VnicTemplate' resource.", "operationId": "PatchVnicVnicTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator", "UPDATE.vnic.VnicTemplate" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vnic.VnicTemplate' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vnic.VnicTemplate' resource was patched as requested. The 'vnic.VnicTemplate' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnic.VnicTemplate" } } }, "links": { "GetVnicVnicTemplateByMoid": { "operationId": "GetVnicVnicTemplateByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vnic/VnicTemplates/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vnic" ], "summary": "Delete a 'vnic.VnicTemplate' resource.", "operationId": "DeleteVnicVnicTemplate", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vnic.VnicTemplate", "PRIVSET.Account Administrator", "PRIVSET.Delete vNIC templates", "PRIVSET.Manage Server Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vrf/Vrves": { "get": { "tags": [ "vrf" ], "summary": "Read a 'vrf.Vrf' resource.", "operationId": "GetVrfVrfList", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.Read-only IQN pools", "PRIVSET.Read-only MAC pools", "PRIVSET.Read-only UUID pools", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.Read-only resource pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.vrf.Vrf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/filterParam" }, { "$ref": "#/components/parameters/orderbyParam" }, { "$ref": "#/components/parameters/topParam" }, { "$ref": "#/components/parameters/skipParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/applyParam" }, { "$ref": "#/components/parameters/countParam" }, { "$ref": "#/components/parameters/inlinecountParam" }, { "$ref": "#/components/parameters/atParam" }, { "$ref": "#/components/parameters/tagsParam" } ], "responses": { "200": { "description": "List of 'vrf.Vrf' resources for the given filter criteria", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf.Response" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vrf" ], "summary": "Create a 'vrf.Vrf' resource.", "operationId": "CreateVrfVrf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "CREATE.vrf.Vrf", "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/IfMatch" }, { "$ref": "#/components/parameters/IfNoneMatch" } ], "requestBody": { "description": "The 'vrf.Vrf' resource to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was created as requested. The 'vrf.Vrf' resource is created before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } } }, "links": { "GetVrfVrfByMoid": { "operationId": "GetVrfVrfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } }, "/api/v1/vrf/Vrves/{Moid}": { "get": { "tags": [ "vrf" ], "summary": "Read a 'vrf.Vrf' resource.", "operationId": "GetVrfVrfByMoid", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Server Profiles", "PRIVSET.Manage Switch Profiles", "PRIVSET.Read-Only", "PRIVSET.Read-only IP pools", "PRIVSET.Read-only IQN pools", "PRIVSET.Read-only MAC pools", "PRIVSET.Read-only UUID pools", "PRIVSET.Read-only WWNN and WWPN pools", "PRIVSET.Read-only resource pools", "PRIVSET.View Server Profiles", "PRIVSET.View Switch Profiles", "READ.vrf.Vrf", "ROLE.Account Administrator", "ROLE.Read-Only" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/selectParam" }, { "$ref": "#/components/parameters/expandParam" }, { "$ref": "#/components/parameters/atParam" } ], "responses": { "200": { "description": "An instance of the 'vrf.Vrf' resource.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" }, "Content-Disposition": { "$ref": "#/components/headers/Content-Disposition" }, "Content-Length": { "$ref": "#/components/headers/Content-Length" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } }, "text/csv": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/CsvFile" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/ExcelFile" } } }, "links": { "GetVrfVrfByMoid": { "operationId": "GetVrfVrfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "post": { "tags": [ "vrf" ], "summary": "Update a 'vrf.Vrf' resource.", "operationId": "UpdateVrfVrf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.vrf.Vrf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vrf.Vrf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was modified as requested. The 'vrf.Vrf' resource is modified before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } } }, "links": { "GetVrfVrfByMoid": { "operationId": "GetVrfVrfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "patch": { "tags": [ "vrf" ], "summary": "Update a 'vrf.Vrf' resource.", "operationId": "PatchVrfVrf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator", "UPDATE.vrf.Vrf" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" }, { "$ref": "#/components/parameters/IfMatch" } ], "requestBody": { "description": "The 'vrf.Vrf' resource to update.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } }, "application/json-patch+json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/PatchDocument" } } } }, "responses": { "200": { "description": "The HTTP 200 status response code indicates that the request has succeeded and the 'vrf.Vrf' resource was patched as requested. The 'vrf.Vrf' resource is patched before this response is sent back and the resource is returned in the body of the message.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vrf.Vrf" } } }, "links": { "GetVrfVrfByMoid": { "operationId": "GetVrfVrfByMoid", "parameters": { "Moid": "$response.body#/Moid" }, "description": "The 'Moid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/vrf/Vrves/{Moid}'." }, "GetIamAccountByMoid": { "$ref": "#/components/links/GetIamAccountByMoid" }, "GetIamDomainGroupByMoid": { "$ref": "#/components/links/GetIamDomainGroupByMoid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } }, "delete": { "tags": [ "vrf" ], "summary": "Delete a 'vrf.Vrf' resource.", "operationId": "DeleteVrfVrf", "security": [ { "cookieAuth": [] }, { "http_signature": [] }, { "oAuth2": [ "DELETE.vrf.Vrf", "PRIVSET.Account Administrator", "PRIVSET.Manage Switch Profiles", "ROLE.Account Administrator" ] } ], "parameters": [ { "$ref": "#/components/parameters/moidParam" } ], "responses": { "200": { "description": "Resource has been deleted successfully.", "headers": { "Set-Cookie": { "$ref": "#/components/headers/Set-Cookie" }, "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } } }, "400": { "$ref": "#/components/responses/http_status_400" }, "401": { "$ref": "#/components/responses/http_status_401" }, "403": { "$ref": "#/components/responses/http_status_403" }, "404": { "$ref": "#/components/responses/http_status_404" }, "default": { "$ref": "#/components/responses/default" } } } } }, "components": { "schemas": { "access.AddressType": { "title": "Type of IP address", "description": "The type of IP address to be configured on the CIMC. Available options are IPv4 and/or IPv6.", "x-allOf-name": "access.AddressType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'access.AddressType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "access.AddressType" ], "default": "access.AddressType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "access.AddressType" ], "default": "access.AddressType", "x-enum-as-string": true }, "EnableIpV4": { "description": "This flag enables the use of IPv4 address for end-point access.", "type": "boolean", "default": true, "x-omitempty": true }, "EnableIpV6": { "description": "This flag enables the use of IPv6 address for end-point access.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "access.ConfigurationType": { "title": "Type of configuration", "description": "The type of configuration, In-Band and/or Out-Of-Band to be configured on the CIMC.", "x-allOf-name": "access.ConfigurationType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'access.ConfigurationType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "access.ConfigurationType" ], "default": "access.ConfigurationType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "access.ConfigurationType" ], "default": "access.ConfigurationType", "x-enum-as-string": true }, "ConfigureInband": { "description": "This flag enables the use of In-Band configuration for end-point access.", "type": "boolean", "default": true, "x-omitempty": true }, "ConfigureOutOfBand": { "description": "This flag enables the use of Out-Of-Band configuration for end-point access.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "access.IpAddress.Response": { "description": "The response body of a HTTP GET request for the 'access.IpAddress' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'access.IpAddress' resources.", "x-one-of-name": "access.IpAddress.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/access.IpAddress.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "access.IpAddress": { "title": "IP Address Lease Information", "description": "The Access IpAddress object is a read-only inventory object that represents the IP address lease information for a specific server profile. This provides a consolidated view of the management IP addresses assigned to a server's management controller.\n#### Purpose\nThis serves as a status and reporting entity, not a configurable one. Its purpose is to display the IPv4 and IPv6 addresses that have been leased to a server profile from the IP pools specified in the corresponding Access Policy. This allows administrators and automation systems to easily query the assigned management IP addresses for a given server.\n#### Key Concepts\n- **Inventory Object:** It reflects the current state of IP allocation and is not directly configurable by users. Its data is populated by the system after an Access policy is successfully deployed.\n- **Read-Only Access:** The API methods for this are limited to READ, reinforcing its role as an informational object.\n- **Lease Association:** It maintains relationships to the underlying IP lease objects (ippool.IpLease), providing a clear link between the assigned address and its source pool.\n- **Profile-Specific:** Each IpAddress instance is tied to a single server profile, showing the specific addresses in use by that server.", "x-allOf-name": "access.IpAddress", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'access.IpAddress', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "access.IpAddress" ], "default": "access.IpAddress", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "access.IpAddress" ], "default": "access.IpAddress", "x-enum-as-string": true }, "Ipv4Address": { "description": "IPv4 Address leased to this Server Profile for In-Band Deployment.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "Ipv6Address": { "description": "IPv4 Address leased to this Server Profile for In-Band Deployment.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "OobIpv4Address": { "description": "IPv4 Address leased to this Server Profile for Out-Of-Band deployment.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "Ipv4Lease": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Ipv6Lease": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OobIpv4Lease": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "access.IpAddress.List": { "title": "List of 'access.IpAddress' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'access.IpAddress' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'access.IpAddress' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/access.IpAddress" }, "nullable": true } } } ] }, "access.Policy.Response": { "description": "The response body of a HTTP GET request for the 'access.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'access.Policy' resources.", "x-one-of-name": "access.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/access.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "access.Policy": { "title": "Access Policy", "description": "The Access Policy object is a reusable policy that configures server and chassis management access options. It allows administrators to define how In-Band and Out-of-Band management IP addresses are assigned and used for endpoints.\n#### Purpose\nThe primary purpose of an Access Policy is to standardize the network access configuration for server management controllers (CIMCs). By defining settings for IP address pools and VLANs, this policy ensures that servers and chassis are consistently and correctly configured for management access across an organization.\n#### Key Concepts\n- **Reusable Configuration:** As an object extending policy.AbstractPolicy, this provides a template for access settings that can be applied to multiple server and chassis profiles.\n- **In-Band and Out-of-Band:** The policy supports both In-Band (shared with data traffic) and Out-of-Band (dedicated management network) configurations.\n- **IP Address Management:** It integrates with Intersight's IP Pool (ippool.Pool) and VRF (vrf.Vrf) objects to automate the assignment of management IP addresses.\n- **Profile-Based Application:** This policy is attached to Server or Chassis profiles to apply its configuration to the associated physical hardware.\n- **Impact Awareness:** Changes to this policy are flagged with MgmtNetworkDisconnection, indicating that applying updates may temporarily interrupt management connectivity to the endpoint.", "x-allOf-name": "access.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'access.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "access.Policy" ], "default": "access.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "access.Policy" ], "default": "access.Policy", "x-enum-as-string": true }, "AddressType": { "description": "The type of address to be retrieved from Inband IP Pool object.", "$ref": "#/components/schemas/access.AddressType", "x-omitempty": true }, "ConfigurationType": { "description": "The type of configuration, In-Band and/or Out-Of-Band to be configured on the CIMC.", "$ref": "#/components/schemas/access.ConfigurationType", "x-omitempty": true }, "InbandVlan": { "description": "VLAN to be used for server access over Inband network. When Inband is enabled, only numbers between 4 to 4093 are allowed.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 4093, "x-omitempty": true }, "InbandIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InbandVrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "OutOfBandIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "OutOfBandVrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "access.Policy.List": { "title": "List of 'access.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'access.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'access.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/access.Policy" }, "nullable": true } } } ] }, "access.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'access.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'access.PolicyInventory' resources.", "x-one-of-name": "access.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/access.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "access.PolicyInventory": { "title": "Access Policy", "description": "The Access Policy object is a reusable policy that configures server and chassis management access options. It allows administrators to define how In-Band and Out-of-Band management IP addresses are assigned and used for endpoints.\n#### Purpose\nThe primary purpose of an Access Policy is to standardize the network access configuration for server management controllers (CIMCs). By defining settings for IP address pools and VLANs, this policy ensures that servers and chassis are consistently and correctly configured for management access across an organization.\n#### Key Concepts\n- **Reusable Configuration:** As an object extending policy.AbstractPolicy, this provides a template for access settings that can be applied to multiple server and chassis profiles.\n- **In-Band and Out-of-Band:** The policy supports both In-Band (shared with data traffic) and Out-of-Band (dedicated management network) configurations.\n- **IP Address Management:** It integrates with Intersight's IP Pool (ippool.Pool) and VRF (vrf.Vrf) objects to automate the assignment of management IP addresses.\n- **Profile-Based Application:** This policy is attached to Server or Chassis profiles to apply its configuration to the associated physical hardware.\n- **Impact Awareness:** Changes to this policy are flagged with MgmtNetworkDisconnection, indicating that applying updates may temporarily interrupt management connectivity to the endpoint.", "x-allOf-name": "access.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'access.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "access.PolicyInventory" ], "default": "access.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "access.PolicyInventory" ], "default": "access.PolicyInventory", "x-enum-as-string": true }, "AddressType": { "description": "The type of address to be retrieved from Inband IP Pool object.", "$ref": "#/components/schemas/access.AddressType", "readOnly": true, "x-omitempty": true }, "ConfigurationType": { "description": "The type of configuration, In-Band and/or Out-Of-Band to be configured on the CIMC.", "$ref": "#/components/schemas/access.ConfigurationType", "readOnly": true, "x-omitempty": true }, "InbandVlan": { "description": "VLAN to be used for server access over Inband network. When Inband is enabled, only numbers between 4 to 4093 are allowed.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 4093, "readOnly": true, "x-omitempty": true }, "InbandIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InbandVrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OutOfBandIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "OutOfBandVrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "access.PolicyInventory.List": { "title": "List of 'access.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'access.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'access.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/access.PolicyInventory" }, "nullable": true } } } ] }, "adapter.AdapterConfig": { "title": "Adapter Configuration", "description": "Global adapter level settings.", "x-allOf-name": "adapter.AdapterConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.AdapterConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.AdapterConfig" ], "default": "adapter.AdapterConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.AdapterConfig" ], "default": "adapter.AdapterConfig", "x-enum-as-string": true }, "DceInterfaceSettings": { "type": "array", "items": { "description": "Collection of DCE interface settings for this adapter.", "$ref": "#/components/schemas/adapter.DceInterfaceSettings", "x-omitempty": true }, "minItems": 0, "maxItems": 4, "nullable": true }, "EthSettings": { "description": "Global Ethernet settings for this adapter.", "$ref": "#/components/schemas/adapter.EthSettings", "x-omitempty": true }, "FcSettings": { "description": "Global Fibre Channel settings for this adapter.", "$ref": "#/components/schemas/adapter.FcSettings", "x-omitempty": true }, "PhysicalNicModeSettings": { "description": "Physical NIC Mode Settings for this adapter.", "$ref": "#/components/schemas/adapter.PhysicalNicModeSettings", "x-omitempty": true }, "PortChannelSettings": { "description": "Port Channel settings for this adapter.", "$ref": "#/components/schemas/adapter.PortChannelSettings", "x-omitempty": true }, "SlotId": { "description": "PCIe slot where the VIC adapter is installed. Supported values are (1-15) and MLOM.", "type": "string", "pattern": "^([1-9]|1[0-5]|MLOM)$", "x-omitempty": true } } } ] }, "adapter.ConfigPolicy.Response": { "description": "The response body of a HTTP GET request for the 'adapter.ConfigPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.ConfigPolicy' resources.", "x-one-of-name": "adapter.ConfigPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.ConfigPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.ConfigPolicy": { "title": "Adapter Configuration", "description": "The ConfigPolicy object is a core element for managing adapter configurations on standalone rack servers. It defines and maintains Ethernet and Fibre Channel settings for Cisco VIC adapters. This policy is not supported on Intersight Managed Mode (IMM) servers.\n#### Purpose\nA ConfigPolicy serves as a policy framework for configuring vital adapter settings, allowing administrators to manage and deploy configurations efficiently. It supports operations such as read, create, update, and delete, facilitating seamless integration with server management workflows.\n#### Key Concepts\n- **Adapter Configuration:** Focuses on configuring Ethernet and Fibre-Channel settings, addressing the needs of various server environments.\n- **Access Control:** Ensures that only authorized users can perform configuration tasks, enhancing security and reliability.", "x-allOf-name": "adapter.ConfigPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.ConfigPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.ConfigPolicy" ], "default": "adapter.ConfigPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.ConfigPolicy" ], "default": "adapter.ConfigPolicy", "x-enum-as-string": true }, "Settings": { "type": "array", "items": { "description": "Configuration for all the adapters available in the server.", "$ref": "#/components/schemas/adapter.AdapterConfig", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "adapter.ConfigPolicy.List": { "title": "List of 'adapter.ConfigPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.ConfigPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.ConfigPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.ConfigPolicy" }, "nullable": true } } } ] }, "adapter.DceInterfaceSettings": { "title": "DCE Interface Settings", "description": "Settings applicable for the Data Center Ethernet (DCE) interfaces on the adapter card.", "x-allOf-name": "adapter.DceInterfaceSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.DceInterfaceSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.DceInterfaceSettings" ], "default": "adapter.DceInterfaceSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.DceInterfaceSettings" ], "default": "adapter.DceInterfaceSettings", "x-enum-as-string": true }, "FecMode": { "description": "Forward Error Correction (FEC) mode setting for the DCE interfaces of the adapter. FEC mode setting is supported only for Cisco VIC 14xx adapters. FEC mode 'cl74' is unsupported for Cisco VIC 1495/1497. This setting will be ignored for unsupported adapters and for unavailable DCE interfaces.\n* `cl91` - Use cl91 standard as FEC mode setting. 'Clause 91' aka RS-FEC ('ReedSolomon' FEC) offers better error protection against bursty and random errors but adds latency.\n* `cl74` - Use cl74 standard as FEC mode setting. 'Clause 74' aka FC-FEC ('FireCode' FEC) offers simple, low-latency protection against 1 burst/sparse bit error, but it is not good for random errors.\n* `Off` - Disable FEC mode on the DCE Interface.", "type": "string", "enum": [ "cl91", "cl74", "Off" ], "default": "cl91", "x-omitempty": true }, "InterfaceId": { "description": "DCE interface id on which settings needs to be configured. Supported values are (0-3).", "type": "integer", "format": "int64", "minimum": 0, "maximum": 3, "x-omitempty": true } } } ] }, "adapter.EthSettings": { "title": "Ethernet Settings", "description": "Global Ethernet settings for this adapter.", "x-allOf-name": "adapter.EthSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.EthSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.EthSettings" ], "default": "adapter.EthSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.EthSettings" ], "default": "adapter.EthSettings", "x-enum-as-string": true }, "LldpEnabled": { "description": "Status of LLDP protocol on the adapter interfaces.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "adapter.ExtEthInterface.Response": { "description": "The response body of a HTTP GET request for the 'adapter.ExtEthInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.ExtEthInterface' resources.", "x-one-of-name": "adapter.ExtEthInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.ExtEthInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.ExtEthInterface.Relationship": { "description": "A relationship to the 'adapter.ExtEthInterface' resource, or the expanded 'adapter.ExtEthInterface' resource, or the 'null' value.", "x-one-of-name": "adapter.ExtEthInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.ExtEthInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.ExtEthInterface": { "title": "Adapter:Ext Eth Interface", "description": "The adapter.ExtEthInterface object represents a physical external port on a Cisco network adapter. This provides a detailed view of the physical link between the adapter and a peer networking device, such as a Fabric Interconnect or a FEX.\n#### Purpose\nThe main purpose of this object is to model and monitor the physical connectivity of an adapter's external-facing ports. It captures essential link-level details, including the MAC address, administrative state, and the identity of the connected peer device. This allows for precise tracking of network topology and troubleshooting of physical link issues.\n#### Key Concepts\n- **Physical Port Representation:** Models a single external Ethernet port on an adapter card.\n- **Peer Discovery:** Identifies the connected peer device and port through properties like peerDn and peerPortId, which is crucial for understanding network topology.\n- **Link State Monitoring:** Tracks the operational status and provides specific reasons (operReason) for link failures, such as LinkMissing or LinkMisconnect.\n- **Hierarchical Context:** Inherits from the adapter.Unit object, linking the physical port back to its parent adapter card.", "x-allOf-name": "adapter.ExtEthInterface", "allOf": [ { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/port.InterfaceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.ExtEthInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.ExtEthInterface" ], "default": "adapter.ExtEthInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.ExtEthInterface" ], "default": "adapter.ExtEthInterface", "x-enum-as-string": true }, "AdminState": { "description": "Admin configured state of an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "EpDn": { "description": "Endpoint Config DN of an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExtEthInterfaceId": { "description": "Unique Identifier for an External Ethernet Interface within the adapter object.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceType": { "description": "Type of an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "MAC address of an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkType": { "description": "Type of network connection or configuration that adapter is using.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The status of the Adapter Links. For Example - AdapterLinkDown as operReason would denote that link is not established on the Switch/FEX.\n* `Unknown` - The health message type is not known.\n* `NotReachable` - Adapter Unit is not reachable from the switch.\n* `LinkMissing` - Adapter Link to the Switch/FEX is missing.\n* `LinkDown` - Adapter port connection to the Switch/FEX is not present.\n* `InvalidConnections` - One or more adapter connections to FI is not valid.\n* `LinkMisconnect` - Adapter Links are misplaced.\n* `CommErrors` - The CIMC is unable to communicate with the VIC.\n* `Counterfeit` - VIC SUDI verification has been evaluated and is not valid.\n* `SecureBootFail` - VIC U-Boot status is unabled to be determined.\n* `BackupImageRunning` - VIC U-Boot is running the golden (backup) image.\n* `FwValidationFailed` - VIC application status is unable to be determined.\n* `AltImageRunning` - VIC application is running the alternate image.\n* `DiagImageRunning` - VIC application is running the diagnostic image.\n* `NotRelKeySigned` - VIC application is running an image that is not release signed.\n* `LowUpgradesRemaining` - VIC FPGA has fewer than 50 upgrades remaining.\n* `NoUpgradesRemaining` - VIC FPGA has no upgrades remaining.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.", "type": "string", "enum": [ "Unknown", "NotReachable", "LinkMissing", "LinkDown", "InvalidConnections", "LinkMisconnect", "CommErrors", "Counterfeit", "SecureBootFail", "BackupImageRunning", "FwValidationFailed", "AltImageRunning", "DiagImageRunning", "NotRelKeySigned", "LowUpgradesRemaining", "NoUpgradesRemaining", "TemperatureWarning", "TemperatureCritical" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PeerAggrPortId": { "description": "Peer Aggregate Port Id attached to an External Ethernet Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PeerDn": { "description": "DN of peer end-point attached to an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerPortId": { "description": "Peer Port Id attached to an External Ethernet Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PeerSlotId": { "description": "Peer Slot Id attached to an External Ethernet Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "SwitchId attached to an External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.ExtEthInterface.List": { "title": "List of 'adapter.ExtEthInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.ExtEthInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.ExtEthInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.ExtEthInterface" }, "nullable": true } } } ] }, "adapter.FcSettings": { "title": "Fibre Channel Settings", "description": "Global Fibre Channel settings for this adapter.", "x-allOf-name": "adapter.FcSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.FcSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.FcSettings" ], "default": "adapter.FcSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.FcSettings" ], "default": "adapter.FcSettings", "x-enum-as-string": true }, "FipEnabled": { "description": "Status of FIP protocol on the adapter interfaces.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "adapter.HostEthInterface.Response": { "description": "The response body of a HTTP GET request for the 'adapter.HostEthInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.HostEthInterface' resources.", "x-one-of-name": "adapter.HostEthInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.HostEthInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.HostEthInterface.Relationship": { "description": "A relationship to the 'adapter.HostEthInterface' resource, or the expanded 'adapter.HostEthInterface' resource, or the 'null' value.", "x-one-of-name": "adapter.HostEthInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.HostEthInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.HostEthInterface": { "title": "Adapter:Host Eth Interface", "description": "The adapter.HostEthInterface object represents a virtual Ethernet interface (vNIC) or a physical port of a non-Cisco adapter as it is presented to the host operating system. It serves as the primary inventory object for a server's logical network connections.\n#### Purpose\nThe HostEthInterface object is designed to model the host-visible network interfaces, providing a comprehensive view of their configuration, status, and relationship with the underlying physical and virtual network infrastructure. It bridges the gap between the server's OS-level view and the network management plane.\n#### Key Concepts\n- **Logical Interface Model:** Represents a vNIC, capturing its name, MAC address, and administrative state.\n- **Failover and Redundancy:** For failover-enabled vNICs, it tracks the status of both primary and standby paths, including their respective virtual interface IDs (vifId and standbyVifId).\n- **Operational State Tracking:** Provides detailed operational states for both the vNIC itself (activeOperState, standbyOperState) and its peer Vethernet interfaces (activeVethOperState, standbyVethOperState) in an Intersight Managed Mode domain.\n- **Action-Oriented:** Supports administrative actions like ResetConnectivity, Enable, and Disable through the vethAction property, allowing for dynamic control over the interface.", "x-allOf-name": "adapter.HostEthInterface", "allOf": [ { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/port.InterfaceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.HostEthInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.HostEthInterface" ], "default": "adapter.HostEthInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.HostEthInterface" ], "default": "adapter.HostEthInterface", "x-enum-as-string": true }, "ActiveOperState": { "description": "The operational state of the Active vNIC. vNIC operational state information is updated by events from the adapter. This operational state is applicable to primary vNIC. If a host is powered off, this property might not be accurate as we may or may not receive events from the adapter. For Intersight Managed Domains Mode domains (IMM), the vNIC's peer object Vethernet will have the current operational state of the connection when a host is powered off.", "type": "string", "readOnly": true, "x-omitempty": true }, "ActiveVethOperState": { "description": "The operational state of the Active Vethernet peer of a vNIC in Intersight Managed Mode. This state is updated by events from Fabric Interconnect or by periodic updates from Fabric Interconnect. When a Fabric Interconnect is not connected to Intersight or if the Fabric Interconnect is powered down, this property will not be updated. This state is not applicable for standalone servers.\n* `unknown` - The operational state of the Vethernet is not known.\n* `adminDown` - The operational state of the Vethernet is admin down.\n* `up` - The operational state of the Vethernet is Up.\n* `down` - The operational state of the Vethernet is Down.\n* `noLicense` - The operational state of the Vethernet is no license.\n* `linkUp` - The operational state of the Vethernet is link up.\n* `hardwareFailure` - The operational state of the Vethernet is hardware failure.\n* `softwareFailure` - The operational state of the Vethernet is software failure.\n* `errorDisabled` - The operational state of the Vethernet is error disabled.\n* `linkDown` - The operational state of the Vethernet is link down.\n* `sfpNotPresent` - The operational state of the Vethernet is SFP not present.\n* `udldAggrDown` - The operational state of the Vethernet is UDLD aggregate down.", "type": "string", "enum": [ "unknown", "adminDown", "up", "down", "noLicense", "linkUp", "hardwareFailure", "softwareFailure", "errorDisabled", "linkDown", "sfpNotPresent", "udldAggrDown" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "AdminState": { "description": "Admin state of the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "EpDn": { "description": "The Endpoint Config Dn of the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostEthInterfaceId": { "description": "Unique Identifier for an Host Ethernet Interface within the adapter object.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InterfaceType": { "description": "Type of External Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "Mac address of the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Host Ethernet Channel Interface.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "x-omitempty": true }, "nullable": true }, "Operability": { "description": "Operability status of Host Ethernet Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OriginalMacAddress": { "description": "The factory default Mac address of the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciAddr": { "description": "The PCI address of the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerDn": { "description": "The distinguished name of the peer endpoint connected to the Host Ethernet interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PinGroupName": { "description": "Name given for Lan PinGroup.", "type": "string", "x-omitempty": true }, "QinqEnabled": { "description": "Setting qinqEnabled to true if we have QinQ tagging enabled on the vNIC.", "type": "boolean", "x-omitempty": true }, "QinqVlan": { "description": "The VLAN ID for VIC QinQ (802.1Q) Tunneling.", "type": "integer", "format": "int64", "default": 2, "x-omitempty": true }, "StandbyOperState": { "description": "The operational state of the standby vNIC. vNIC operational state information is updated by events from the adapter. This operational state is applicable only to failover vNIC. If a host is powered off, this property might not be accurate as we may or may not receive events from the adapter. For Intersight Managed Mode domains (IMM), the vNIC's peer object Vethernet will have the current operational state of the connection when a host is powered off.", "type": "string", "readOnly": true, "x-omitempty": true }, "StandbyVethOperState": { "description": "The operational state of the Standby Vethernet peer of a failover vNIC in Intersight Managed Mode. This state is updated by events from Fabric Interconnect or by periodic updates from Fabric Interconnect. When a Fabric Interconnect is not connected to Intersight or if the Fabric Interconnect is powered down, this property will not be updated. This state is not applicable for standalone servers.\n* `unknown` - The operational state of the Vethernet is not known.\n* `adminDown` - The operational state of the Vethernet is admin down.\n* `up` - The operational state of the Vethernet is Up.\n* `down` - The operational state of the Vethernet is Down.\n* `noLicense` - The operational state of the Vethernet is no license.\n* `linkUp` - The operational state of the Vethernet is link up.\n* `hardwareFailure` - The operational state of the Vethernet is hardware failure.\n* `softwareFailure` - The operational state of the Vethernet is software failure.\n* `errorDisabled` - The operational state of the Vethernet is error disabled.\n* `linkDown` - The operational state of the Vethernet is link down.\n* `sfpNotPresent` - The operational state of the Vethernet is SFP not present.\n* `udldAggrDown` - The operational state of the Vethernet is UDLD aggregate down.", "type": "string", "enum": [ "unknown", "adminDown", "up", "down", "noLicense", "linkUp", "hardwareFailure", "softwareFailure", "errorDisabled", "linkDown", "sfpNotPresent", "udldAggrDown" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "StandbyVifId": { "description": "Identifier of the Standby virtual ethernet interface (Vethernet) on the networking component (e.g., Fabric Interconnect) for the corresponding Host Ethernet Interface (vNIC).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VethAction": { "description": "The action to be performed on the vethernet corresponding to the vNIC.\n* `None` - Default value for vif operation.\n* `ResetConnectivity` - Resets connectivity on both active and passive vif.\n* `ResetConnectivityActive` - Resets connectivity on the active vif.\n* `ResetConnectivityPassive` - Resets connectivity on the passive vif.\n* `Enable` - Enables the vif on both the FIs.\n* `Disable` - Disables the vif on both the FIs.\n* `EnableActive` - Enables the corresponding active vif.\n* `EnablePassive` - Enables the corresponding standby vif.\n* `DisableActive` - Disables the corresponding active vif.\n* `DisablePassive` - Disables the corresponding standby vif.", "type": "string", "enum": [ "None", "ResetConnectivity", "ResetConnectivityActive", "ResetConnectivityPassive", "Enable", "Disable", "EnableActive", "EnablePassive", "DisableActive", "DisablePassive" ], "default": "None", "x-omitempty": true }, "VifId": { "description": "Identifier of the virtual ethernet interface (Vethernet) on the networking component (e.g., Fabric Interconnect) for the corresponding Host Ethernet Interface (vNIC).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VirtualizationPreference": { "description": "Virtualization Preference of the Host Ethernet Interface indicating if virtualization is enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "VnicDn": { "description": "The Virtual Ethernet Interface DN connected to the Host Ethernet Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PinnedInterface": { "$ref": "#/components/schemas/inventory.Interface.Relationship", "description": "A reference to a inventoryInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StandbyVethernet": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Vethernet.Relationship", "description": "A reference to a networkVethernet resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vethernet": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Vethernet.Relationship", "description": "A reference to a networkVethernet resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.HostEthInterface.List": { "title": "List of 'adapter.HostEthInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.HostEthInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.HostEthInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostEthInterface" }, "nullable": true } } } ] }, "adapter.HostFcInterface.Response": { "description": "The response body of a HTTP GET request for the 'adapter.HostFcInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.HostFcInterface' resources.", "x-one-of-name": "adapter.HostFcInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.HostFcInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.HostFcInterface.Relationship": { "description": "A relationship to the 'adapter.HostFcInterface' resource, or the expanded 'adapter.HostFcInterface' resource, or the 'null' value.", "x-one-of-name": "adapter.HostFcInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.HostFcInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.HostFcInterface": { "title": "Adapter:Host Fc Interface", "description": "The adapter.HostFcInterface object represents a virtual Fibre Channel Host Bus Adapter (vHBA) as it is presented to the host operating system. It is the primary inventory object for a server's logical storage connections over a Fibre Channel network.\n#### Purpose\nThe HostFcInterface object models a host-visible vHBA, providing a complete view of its configuration, identity, and operational status. It is essential for managing and monitoring Fibre Channel connectivity from the server to the storage area network (SAN).\n#### Key Concepts\n- **Logical Storage Interface:** Represents a vHBA, capturing its unique identity through World Wide Port Name (WWPN) and World Wide Node Name (WWNN).\n- **Identity Management:** Tracks both the configured (wwpn, wwnn) and factory-default (originalWwpn, originalWwnn) worldwide names.\n- **Connectivity Pinning:** Identifies the pinned uplink SAN interface (pinnedInterface) and the associated virtual Fibre Channel interface (vfc) on the Fabric Interconnect.\n- **Operational Control:** Supports administrative actions like ResetConnectivity, Enable, and Disable via the vfcAction property, enabling direct management of the vHBA's state.", "x-allOf-name": "adapter.HostFcInterface", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.HostFcInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.HostFcInterface" ], "default": "adapter.HostFcInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.HostFcInterface" ], "default": "adapter.HostFcInterface", "x-enum-as-string": true }, "AdminState": { "description": "Admin Configured State of Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "EpDn": { "description": "The Endpoint Config Dn of the Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostFcInterfaceId": { "description": "Identifier of Host Fibre Channel Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Host Fibre Channel Interface.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational State of Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability status of Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OriginalWwnn": { "description": "The uniquely distinguishable factory default World Wide Node Name of the Host.", "type": "string", "readOnly": true, "x-omitempty": true }, "OriginalWwpn": { "description": "The uniquely distinguishable factory default World Wide Port Name of the Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerDn": { "description": "PeerPort Dn of Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PinGroupName": { "description": "Name given for San PinGroup.", "type": "string", "x-omitempty": true }, "VfcAction": { "description": "Denotes the action to be performed on the vfc corresponding to the vHBA.\n* `None` - Default value for vif operation.\n* `ResetConnectivity` - Resets connectivity on both active and passive vif.\n* `ResetConnectivityActive` - Resets connectivity on the active vif.\n* `ResetConnectivityPassive` - Resets connectivity on the passive vif.\n* `Enable` - Enables the vif on both the FIs.\n* `Disable` - Disables the vif on both the FIs.\n* `EnableActive` - Enables the corresponding active vif.\n* `EnablePassive` - Enables the corresponding standby vif.\n* `DisableActive` - Disables the corresponding active vif.\n* `DisablePassive` - Disables the corresponding standby vif.", "type": "string", "enum": [ "None", "ResetConnectivity", "ResetConnectivityActive", "ResetConnectivityPassive", "Enable", "Disable", "EnableActive", "EnablePassive", "DisableActive", "DisablePassive" ], "default": "None", "x-omitempty": true }, "VifId": { "description": "Identifier of the virtual fibre channel (Vfc) interface on the networking component (e.g., Fabric Interconnect) for the corresponding Host Fibre Channel Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Wwnn": { "description": "The uniquely distinguishable user configured World Wide Node Name of the Host.", "type": "string", "readOnly": true, "x-omitempty": true }, "Wwpn": { "description": "The uniquely distinguishable user configured World Wide Port Name of the Host Fibre Channel Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PinnedInterface": { "$ref": "#/components/schemas/inventory.Interface.Relationship", "description": "A reference to a inventoryInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vfc": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Vfc.Relationship", "description": "A reference to a networkVfc resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.HostFcInterface.List": { "title": "List of 'adapter.HostFcInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.HostFcInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.HostFcInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostFcInterface" }, "nullable": true } } } ] }, "adapter.HostIscsiInterface.Response": { "description": "The response body of a HTTP GET request for the 'adapter.HostIscsiInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.HostIscsiInterface' resources.", "x-one-of-name": "adapter.HostIscsiInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.HostIscsiInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.HostIscsiInterface.Relationship": { "description": "A relationship to the 'adapter.HostIscsiInterface' resource, or the expanded 'adapter.HostIscsiInterface' resource, or the 'null' value.", "x-one-of-name": "adapter.HostIscsiInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.HostIscsiInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.HostIscsiInterface": { "title": "Adapter:Host Iscsi Interface", "description": "The adapter.HostIscsiInterface object represents a virtual iSCSI interface as it is presented to the host operating system. It is used to model and manage iSCSI-based storage connectivity for a server.\n#### Purpose\nThe main function of the HostIscsiInterface object is to provide an inventory of iSCSI interfaces on a server's adapter. It captures the essential configuration and status details required for iSCSI network communication, such as its name, administrative state, and MAC address.\n#### Key Concepts\n- **iSCSI Interface Model:** Represents a logical iSCSI initiator interface on the adapter.\n- **Identity and State:** Tracks the interface's unique name, administrative state (adminState), and operational state (operState).\n- **Host Visibility:** The hostVisible property indicates whether the interface is exposed to the host operating system.\n- **Hierarchical Context:** Is a child of an adapter.Unit object, linking it directly to the physical adapter it resides on.", "x-allOf-name": "adapter.HostIscsiInterface", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.HostIscsiInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.HostIscsiInterface" ], "default": "adapter.HostIscsiInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.HostIscsiInterface" ], "default": "adapter.HostIscsiInterface", "x-enum-as-string": true }, "AdminState": { "description": "Admin Configured State of Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "EpDn": { "description": "The Endpoint Config Dn of the Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostIscsiInterfaceId": { "description": "Identifier of the Host ISCSI Interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HostVisible": { "description": "The visibility of the Host to the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "MAC address of Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational State of Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability status of Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PeerDn": { "description": "PeerPort Dn of Host ISCSI Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.HostIscsiInterface.List": { "title": "List of 'adapter.HostIscsiInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.HostIscsiInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.HostIscsiInterface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostIscsiInterface" }, "nullable": true } } } ] }, "adapter.PhysicalNicModeSettings": { "title": "Physical NIC Mode Settings", "description": "Global Physical NIC Mode Settings for this adapter.", "x-allOf-name": "adapter.PhysicalNicModeSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.PhysicalNicModeSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.PhysicalNicModeSettings" ], "default": "adapter.PhysicalNicModeSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.PhysicalNicModeSettings" ], "default": "adapter.PhysicalNicModeSettings", "x-enum-as-string": true }, "PhyNicEnabled": { "description": "When Physical NIC Mode is enabled, up-link ports of the VIC are set to pass-through mode. This allows the host to transmit packets without any modification. When Physical NIC Mode is enabled, VLAN tagging of the packets will not happen.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "adapter.PortChannelSettings": { "title": "Port Channel Settings", "description": "Port Channel setting for this adapter.", "x-allOf-name": "adapter.PortChannelSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.PortChannelSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.PortChannelSettings" ], "default": "adapter.PortChannelSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.PortChannelSettings" ], "default": "adapter.PortChannelSettings", "x-enum-as-string": true }, "Enabled": { "description": "When Port Channel is enabled, two vNICs and two vHBAs are available for use on the adapter card. When Port Channel is disabled, four vNICs and four vHBAs are available for use on the adapter card. Disabling Port Channel reboots the server. Port Channel is supported only on Cisco VIC Quad Port adapters.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "adapter.Unit.Response": { "description": "The response body of a HTTP GET request for the 'adapter.Unit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.Unit' resources.", "x-one-of-name": "adapter.Unit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.Unit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.Unit.Relationship": { "description": "A relationship to the 'adapter.Unit' resource, or the expanded 'adapter.Unit' resource, or the 'null' value.", "x-one-of-name": "adapter.Unit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.Unit" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.Unit": { "title": "Adapter:Unit", "description": "The adapter.Unit object represents a physical network adapter installed in a server. It serves as a central inventory object for a server's network interface cards (NICs), encapsulating hardware details, operational status, and connectivity information.\n#### Purpose\nThe primary purpose of the adapter.Unit object is to provide a detailed, queryable representation of a physical adapter. This includes its identity (model, serial, part number), its physical location (PCI slot), and its current operational health. It acts as a parent object for more specific interface types, such as host-facing Ethernet and Fibre Channel interfaces.\n#### Key Concepts\n- **Centralized Inventory:** Aggregates all relevant information about a single adapter card, from hardware specifications to its power and thermal state.\n- **Hierarchical Structure:** Acts as a container for related interface objects like HostEthInterface and HostFcInterface, providing a structured view of the adapter's capabilities.\n- **Health Monitoring:** Reports on the adapter's operability, power, and thermal status, including specific operational reasons for any issues detected (e.g., AdapterNotReachable, Counterfeit).\n- **Physical Location:** Clearly identifies the adapter's location within the server via its pciSlot property, aiding in physical identification and maintenance.", "x-allOf-name": "adapter.Unit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.Unit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.Unit" ], "default": "adapter.Unit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.Unit" ], "default": "adapter.Unit", "x-enum-as-string": true }, "AdapterId": { "description": "Unique Identifier of an adapter Unit within a Rack Interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "BaseMacAddress": { "description": "Original Base Mac address of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Connectivity Status of adapter - A or B or AB.", "type": "string", "readOnly": true, "x-omitempty": true }, "Integrated": { "description": "Cisco Integrated adapter or other type.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The Operational state of the Adapter. For Example - AdapterNotReachable as operReason would denote that adapter data path is not reachable from Switch/FEX.\n* `Unknown` - The health message type is not known.\n* `NotReachable` - Adapter Unit is not reachable from the switch.\n* `LinkMissing` - Adapter Link to the Switch/FEX is missing.\n* `LinkDown` - Adapter port connection to the Switch/FEX is not present.\n* `InvalidConnections` - One or more adapter connections to FI is not valid.\n* `LinkMisconnect` - Adapter Links are misplaced.\n* `CommErrors` - The CIMC is unable to communicate with the VIC.\n* `Counterfeit` - VIC SUDI verification has been evaluated and is not valid.\n* `SecureBootFail` - VIC U-Boot status is unabled to be determined.\n* `BackupImageRunning` - VIC U-Boot is running the golden (backup) image.\n* `FwValidationFailed` - VIC application status is unable to be determined.\n* `AltImageRunning` - VIC application is running the alternate image.\n* `DiagImageRunning` - VIC application is running the diagnostic image.\n* `NotRelKeySigned` - VIC application is running an image that is not release signed.\n* `LowUpgradesRemaining` - VIC FPGA has fewer than 50 upgrades remaining.\n* `NoUpgradesRemaining` - VIC FPGA has no upgrades remaining.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.", "type": "string", "enum": [ "Unknown", "NotReachable", "LinkMissing", "LinkDown", "InvalidConnections", "LinkMisconnect", "CommErrors", "Counterfeit", "SecureBootFail", "BackupImageRunning", "FwValidationFailed", "AltImageRunning", "DiagImageRunning", "NotRelKeySigned", "LowUpgradesRemaining", "NoUpgradesRemaining", "TemperatureWarning", "TemperatureCritical" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability state of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part number of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "PCIe slot of the adapter in the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Power": { "description": "Power state of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "Thermal state of an adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "VicCommunicable": { "description": "Records the current state of communication between the Virtual Interface Card (VIC) and the Cisco Integrated Management Controller (CIMC) on the server.\n* `Not Applicable` - Set the state of VIC communication to Not Applicable for other Platforms.\n* `Yes` - VIC is reachable from CIMC.\n* `No` - VIC is not reachable from CIMC.", "type": "string", "enum": [ "Not Applicable", "Yes", "No" ], "default": "Not Applicable", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "Virtual Id of the adapter in the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnitExpander": { "$ref": "#/components/schemas/adapter.UnitExpander.Relationship", "description": "A reference to a adapterUnitExpander resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Controller": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentSharedAdapterUnit": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit.Relationship", "description": "A reference to a equipmentSharedAdapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExtEthIfs": { "description": "An array of relationships to adapterExtEthInterface resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.ExtEthInterface.Relationship" }, "nullable": true, "readOnly": true }, "HostEthIfs": { "description": "An array of relationships to adapterHostEthInterface resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostEthInterface.Relationship" }, "nullable": true, "readOnly": true }, "HostFcIfs": { "description": "An array of relationships to adapterHostFcInterface resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostFcInterface.Relationship" }, "nullable": true, "readOnly": true }, "HostIscsiIfs": { "description": "An array of relationships to adapterHostIscsiInterface resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.HostIscsiInterface.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.Unit.List": { "title": "List of 'adapter.Unit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.Unit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.Unit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.Unit" }, "nullable": true } } } ] }, "adapter.UnitExpander.Response": { "description": "The response body of a HTTP GET request for the 'adapter.UnitExpander' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'adapter.UnitExpander' resources.", "x-one-of-name": "adapter.UnitExpander.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/adapter.UnitExpander.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "adapter.UnitExpander.Relationship": { "description": "A relationship to the 'adapter.UnitExpander' resource, or the expanded 'adapter.UnitExpander' resource, or the 'null' value.", "x-one-of-name": "adapter.UnitExpander.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/adapter.UnitExpander" } ], "discriminator": { "propertyName": "ClassId" } }, "adapter.UnitExpander": { "title": "Adapter:Unit Expander", "description": "The adapter.UnitExpander object represents a physical extension card for a network adapter within a server. It is used for inventory and to identify expander cards that augment the functionality or port count of a primary adapter.\n#### Purpose\nThe UnitExpander object serves to inventory adapter extension cards, which are not full-featured adapters themselves but provide additional physical connectivity. It captures key hardware identifiers to ensure the component can be correctly identified and managed within the system.\n#### Key Concepts\n- **Hardware Identification:** Provides essential hardware details such as partNumber and vid (virtual ID) for unique identification.\n- **Hierarchical Relationship:** It is directly associated with a parent adapter.Unit object, clearly defining its role as an extension of a primary adapter.\n- **Simplified Model:** Focuses purely on the identity of the expander hardware, distinct from the more complex adapter.Unit which models the full adapter.", "x-allOf-name": "adapter.UnitExpander", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'adapter.UnitExpander', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "adapter.UnitExpander" ], "default": "adapter.UnitExpander", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "adapter.UnitExpander" ], "default": "adapter.UnitExpander", "x-enum-as-string": true }, "PartNumber": { "description": "This field identifies the partNumber of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the virtual id of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "adapter.UnitExpander.List": { "title": "List of 'adapter.UnitExpander' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'adapter.UnitExpander' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'adapter.UnitExpander' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.UnitExpander" }, "nullable": true } } } ] }, "bios.BaseBiosConfiguration": { "title": "Bios:Base Bios Configuration", "description": "Lists the BIOS tokens configuration per platform.", "x-allOf-name": "bios.BaseBiosConfiguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "bios.BaseBiosToken": { "title": "Bios:Base Bios Token", "description": "Base type for all BIOS tokens.", "x-allOf-name": "bios.BaseBiosToken", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "bios.BootDevice.Response": { "description": "The response body of a HTTP GET request for the 'bios.BootDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.BootDevice' resources.", "x-one-of-name": "bios.BootDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.BootDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.BootDevice.Relationship": { "description": "A relationship to the 'bios.BootDevice' resource, or the expanded 'bios.BootDevice' resource, or the 'null' value.", "x-one-of-name": "bios.BootDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.BootDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.BootDevice": { "title": "Bios:Boot Device", "description": "Actual boot devices of the system as enumerated by BIOS.", "x-allOf-name": "bios.BootDevice", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.BootDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.BootDevice" ], "default": "bios.BootDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.BootDevice" ], "default": "bios.BootDevice", "x-enum-as-string": true }, "DeviceName": { "description": "Name of the Configured Boot Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "Type of the Configured Boot Device.", "type": "string", "readOnly": true, "x-omitempty": true }, "BiosSystemBootOrder": { "$ref": "#/components/schemas/bios.SystemBootOrder.Relationship", "description": "A reference to a biosSystemBootOrder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bios.BootDevice.List": { "title": "List of 'bios.BootDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.BootDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.BootDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.BootDevice" }, "nullable": true } } } ] }, "bios.BootMode.Response": { "description": "The response body of a HTTP GET request for the 'bios.BootMode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.BootMode' resources.", "x-one-of-name": "bios.BootMode.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.BootMode.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.BootMode.Relationship": { "description": "A relationship to the 'bios.BootMode' resource, or the expanded 'bios.BootMode' resource, or the 'null' value.", "x-one-of-name": "bios.BootMode.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.BootMode" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.BootMode": { "title": "Bios:Boot Mode", "description": "The bios.BootMode object represents the configured boot mode of a server as reported by its BIOS. This provides a clear distinction between the actual boot mode used by the platform and the desired mode set in a policy.\n#### Purpose\nThe main function of this object is to provide an accurate, read-only inventory of the server's current boot mode (e.g., UEFI or Legacy). This allows administrators and automation systems to verify that the server is operating in the expected boot mode and to detect any discrepancies with configured policies.\n#### Key Concepts\n- **Actual State Inventory:** Captures the actualBootMode as reported directly by the server's BIOS, providing a ground-truth value.\n- **Configuration Verification:** Enables comparison between the actual state and the desired state defined in a boot policy.\n- **Read-Only:** Serves as a reporting mechanism rather than a configuration object, ensuring data integrity.\n- **Server-Specific:** Directly associated with a compute.Blade or compute.RackUnit, providing boot mode information for a specific physical server.", "x-allOf-name": "bios.BootMode", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.BootMode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.BootMode" ], "default": "bios.BootMode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.BootMode" ], "default": "bios.BootMode", "x-enum-as-string": true }, "ActualBootMode": { "description": "The actual BIOS boot mode as reported by the platform BIOS.", "type": "string", "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bios.BootMode.List": { "title": "List of 'bios.BootMode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.BootMode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.BootMode' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.BootMode" }, "nullable": true } } } ] }, "bios.C845BaseBiosToken": { "title": "Bios:C845 Base Bios Token", "description": "Base type for C845 BIOS tokens.", "x-allOf-name": "bios.C845BaseBiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.BaseBiosToken" } ] }, "bios.C845ServerBiosConfiguration": { "title": "Bios:C845 Server Bios Configuration", "description": "Bios Tokens configuration for C845 Servers.", "x-allOf-name": "bios.C845ServerBiosConfiguration", "allOf": [ { "$ref": "#/components/schemas/bios.BaseBiosConfiguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.C845ServerBiosConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.C845ServerBiosConfiguration" ], "default": "bios.C845ServerBiosConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.C845ServerBiosConfiguration" ], "default": "bios.C845ServerBiosConfiguration", "x-enum-as-string": true }, "BiosTokens": { "type": "array", "items": { "description": "Collection of BIOS token configurations for the C845 server platform.", "$ref": "#/components/schemas/bios.C845BaseBiosToken", "x-omitempty": true }, "nullable": true } } } ] }, "bios.CbsCmnApbdisC845BiosToken": { "title": "Bios:Cbs Cmn Apbdis C845 Bios Token", "description": "CbsCmnApbdis bios token property.", "x-allOf-name": "bios.CbsCmnApbdisC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnApbdisC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnApbdisC845BiosToken" ], "default": "bios.CbsCmnApbdisC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnApbdisC845BiosToken" ], "default": "bios.CbsCmnApbdisC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "0 = not APBDIS (mission mode) 1 = APBDIS.\n* `Auto` - Value -- Auto for configuring CbsCmnApbdis token.\n* `0` - Value -- 0 for configuring CbsCmnApbdis token.\n* `1` - Value -- 1 for configuring CbsCmnApbdis token.", "type": "string", "enum": [ "Auto", "0", "1" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuAvx512C845BiosToken": { "title": "Bios:Cbs Cmn Cpu Avx512 C845 Bios Token", "description": "CbsCmnCpuAvx512 bios token property.", "x-allOf-name": "bios.CbsCmnCpuAvx512C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuAvx512C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuAvx512C845BiosToken" ], "default": "bios.CbsCmnCpuAvx512C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuAvx512C845BiosToken" ], "default": "bios.CbsCmnCpuAvx512C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or disable AVX-512.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuAvx512 token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnCpuAvx512 token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnCpuAvx512 token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuCpbC845BiosToken": { "title": "Bios:Cbs Cmn Cpu Cpb C845 Bios Token", "description": "CbsCmnCpuCpb bios token property.", "x-allOf-name": "bios.CbsCmnCpuCpbC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuCpbC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuCpbC845BiosToken" ], "default": "bios.CbsCmnCpuCpbC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuCpbC845BiosToken" ], "default": "bios.CbsCmnCpuCpbC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Disable Core Performance Boost (CPB).\n* `Auto` - Value -- Auto for configuring CbsCmnCpuCpb token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnCpuCpb token.", "type": "string", "enum": [ "Auto", "Disabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuDowncoreModeC845BiosToken": { "title": "Bios:Cbs Cmn Cpu Downcore Mode C845 Bios Token", "description": "CbsCmnCpuDowncoreMode bios token property.", "x-allOf-name": "bios.CbsCmnCpuDowncoreModeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuDowncoreModeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuDowncoreModeC845BiosToken" ], "default": "bios.CbsCmnCpuDowncoreModeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuDowncoreModeC845BiosToken" ], "default": "bios.CbsCmnCpuDowncoreModeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Select the DownCore Mode.\n* `Enablement Option` - Value -- Enablement Option for configuring CbsCmnCpuDowncoreMode token.\n* `Bitmap` - Value -- Bitmap for configuring CbsCmnCpuDowncoreMode token.", "type": "string", "enum": [ "Enablement Option", "Bitmap" ], "default": "Enablement Option", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken": { "title": "Bios:Cbs Cmn Cpu Global Cstate Ctrl C845 Bios Token", "description": "CbsCmnCpuGlobalCstateCtrl bios token property.", "x-allOf-name": "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken" ], "default": "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken" ], "default": "bios.CbsCmnCpuGlobalCstateCtrlC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Controls IO based C-state generation and DF C-states.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuGlobalCstateCtrl token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnCpuGlobalCstateCtrl token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnCpuGlobalCstateCtrl token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken": { "title": "Bios:Cbs Cmn Cpu L1 Burst Prefetch Mode C845 Bios Token", "description": "CbsCmnCpuL1BurstPrefetchMode bios token property.", "x-allOf-name": "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken" ], "default": "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken" ], "default": "bios.CbsCmnCpuL1BurstPrefetchModeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Option to Enable | Disable L1 Burst Prefetch Mode.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuL1BurstPrefetchMode token.\n* `Disable` - Value -- Disable for configuring CbsCmnCpuL1BurstPrefetchMode token.\n* `Enable` - Value -- Enable for configuring CbsCmnCpuL1BurstPrefetchMode token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken": { "title": "Bios:Cbs Cmn Cpu L1 Stream Hw Prefetcher C845 Bios Token", "description": "CbsCmnCpuL1StreamHwPrefetcher bios token property.", "x-allOf-name": "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken" ], "default": "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken" ], "default": "bios.CbsCmnCpuL1StreamHwPrefetcherC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Option to Enable | Disable L1 Stream HW Prefetcher.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuL1StreamHwPrefetcher token.\n* `Disable` - Value -- Disable for configuring CbsCmnCpuL1StreamHwPrefetcher token.\n* `Enable` - Value -- Enable for configuring CbsCmnCpuL1StreamHwPrefetcher token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken": { "title": "Bios:Cbs Cmn Cpu L2 Stream Hw Prefetcher C845 Bios Token", "description": "CbsCmnCpuL2StreamHwPrefetcher bios token property.", "x-allOf-name": "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken" ], "default": "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken" ], "default": "bios.CbsCmnCpuL2StreamHwPrefetcherC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Option to Enable | Disable L2 Stream HW Prefetcher.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuL2StreamHwPrefetcher token.\n* `Disable` - Value -- Disable for configuring CbsCmnCpuL2StreamHwPrefetcher token.\n* `Enable` - Value -- Enable for configuring CbsCmnCpuL2StreamHwPrefetcher token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuSmeeC845BiosToken": { "title": "Bios:Cbs Cmn Cpu Smee C845 Bios Token", "description": "CbsCmnCpuSmee bios token property.", "x-allOf-name": "bios.CbsCmnCpuSmeeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuSmeeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuSmeeC845BiosToken" ], "default": "bios.CbsCmnCpuSmeeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuSmeeC845BiosToken" ], "default": "bios.CbsCmnCpuSmeeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Control secure memory encryption enable Enabling both SMEE and SME-MK is not supported. Results in #GP.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuSmee token.\n* `Disable` - Value -- Disable for configuring CbsCmnCpuSmee token.\n* `Enable` - Value -- Enable for configuring CbsCmnCpuSmee token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken": { "title": "Bios:Cbs Cmn Cpu Streaming Stores Ctrl C845 Bios Token", "description": "CbsCmnCpuStreamingStoresCtrl bios token property.", "x-allOf-name": "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken" ], "default": "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken" ], "default": "bios.CbsCmnCpuStreamingStoresCtrlC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enables or disables the streaming stores functionality.\n* `Auto` - Value -- Auto for configuring CbsCmnCpuStreamingStoresCtrl token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnCpuStreamingStoresCtrl token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnCpuStreamingStoresCtrl token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken": { "title": "Bios:Cbs Cmn Cxl Mem Online Offline C845 Bios Token", "description": "CbsCmnCxlMemOnlineOffline bios token property.", "x-allOf-name": "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnCxlMemOnlineOfflineC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken" ], "default": "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken" ], "default": "bios.CbsCmnCxlMemOnlineOfflineC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "All 4 Plink slots support memory online/offline Only slot4 of Amber supports hot plug CXL memory interleaving automatically disabled globally when this CBS is enabled.\n* `Disabled` - Value -- Disabled for configuring CbsCmnCxlMemOnlineOffline token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnCxlMemOnlineOffline token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.CbsCmnDeterminismCtlC845BiosToken": { "title": "Bios:Cbs Cmn Determinism Ctl C845 Bios Token", "description": "CbsCmnDeterminismCtl bios token property.", "x-allOf-name": "bios.CbsCmnDeterminismCtlC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnDeterminismCtlC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnDeterminismCtlC845BiosToken" ], "default": "bios.CbsCmnDeterminismCtlC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnDeterminismCtlC845BiosToken" ], "default": "bios.CbsCmnDeterminismCtlC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Auto = Use default performance determinism settings Manual = User can set custom performance determinism settings.\n* `Auto` - Value -- Auto for configuring CbsCmnDeterminismCtl token.\n* `Manual` - Value -- Manual for configuring CbsCmnDeterminismCtl token.", "type": "string", "enum": [ "Auto", "Manual" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnDeterminismEnableC845BiosToken": { "title": "Bios:Cbs Cmn Determinism Enable C845 Bios Token", "description": "CbsCmnDeterminismEnable bios token property.", "x-allOf-name": "bios.CbsCmnDeterminismEnableC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnDeterminismEnableC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnDeterminismEnableC845BiosToken" ], "default": "bios.CbsCmnDeterminismEnableC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnDeterminismEnableC845BiosToken" ], "default": "bios.CbsCmnDeterminismEnableC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "[0 = Power; 1 = Performance].\n* `Power` - Value -- Power for configuring CbsCmnDeterminismEnable token.\n* `Performance` - Value -- Performance for configuring CbsCmnDeterminismEnable token.", "type": "string", "enum": [ "Power", "Performance" ], "default": "Power", "x-omitempty": true } } } ] }, "bios.CbsCmnGnbNbIommuC845BiosToken": { "title": "Bios:Cbs Cmn Gnb Nb Iommu C845 Bios Token", "description": "CbsCmnGnbNbIOMMU bios token property.", "x-allOf-name": "bios.CbsCmnGnbNbIommuC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnGnbNbIommuC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnGnbNbIommuC845BiosToken" ], "default": "bios.CbsCmnGnbNbIommuC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnGnbNbIommuC845BiosToken" ], "default": "bios.CbsCmnGnbNbIommuC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable Input-Output Memory Management Unit (IOMMU).\n* `Auto` - Value -- Auto for configuring CbsCmnGnbNbIommu token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnGnbNbIommu token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnGnbNbIommu token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken": { "title": "Bios:Cbs Cmn Mem Boot Time Post Package Repair C845 Bios Token", "description": "CbsCmnMemBootTimePostPackageRepair bios token property.", "x-allOf-name": "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken" ], "default": "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken" ], "default": "bios.CbsCmnMemBootTimePostPackageRepairC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable DRAM Boot Time Post Package Repair.\n* `Disable` - Value -- Disable for configuring CbsCmnMemBootTimePostPackageRepair token.\n* `Enable` - Value -- Enable for configuring CbsCmnMemBootTimePostPackageRepair token.", "type": "string", "enum": [ "Disable", "Enable" ], "default": "Disable", "x-omitempty": true } } } ] }, "bios.CbsCmnMemCsInterleaveDdrC845BiosToken": { "title": "Bios:Cbs Cmn Mem Cs Interleave Ddr C845 Bios Token", "description": "CbsCmnMemCsInterleaveDdr bios token property.", "x-allOf-name": "bios.CbsCmnMemCsInterleaveDdrC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemCsInterleaveDdrC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemCsInterleaveDdrC845BiosToken" ], "default": "bios.CbsCmnMemCsInterleaveDdrC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemCsInterleaveDdrC845BiosToken" ], "default": "bios.CbsCmnMemCsInterleaveDdrC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Interleave memory blocks across the DRAM chip selects for node 0.\n* `Auto` - Value -- Auto for configuring CbsCmnMemCsInterleaveDdr token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemCsInterleaveDdr token.", "type": "string", "enum": [ "Auto", "Disabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken": { "title": "Bios:Cbs Cmn Mem Ctrller Bank Swap Mode Ddr C845 Bios Token", "description": "CbsCmnMemCtrllerBankSwapModeDdr bios token property.", "x-allOf-name": "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken" ], "default": "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken" ], "default": "bios.CbsCmnMemCtrllerBankSwapModeDdrC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "BankSwapMode value: 0=Disabled, 1=SwapCPU.\n* `Auto` - Value -- Auto for configuring CbsCmnMemCtrllerBankSwapModeDdr token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemCtrllerBankSwapModeDdr token.\n* `Swap CPU` - Value -- Swap CPU for configuring CbsCmnMemCtrllerBankSwapModeDdr token.", "type": "string", "enum": [ "Auto", "Disabled", "Swap CPU" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken": { "title": "Bios:Cbs Cmn Mem Ctrller Pwr Dn En Ddr C845 Bios Token", "description": "CbsCmnMemCtrllerPwrDnEnDdr bios token property.", "x-allOf-name": "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken" ], "default": "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken" ], "default": "bios.CbsCmnMemCtrllerPwrDnEnDdrC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or disable DDR power down mode.\n* `Auto` - Value -- Auto for configuring CbsCmnMemCtrllerPwrDnEnDdr token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemCtrllerPwrDnEnDdr token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnMemCtrllerPwrDnEnDdr token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnMemDramRefreshRateC845BiosToken": { "title": "Bios:Cbs Cmn Mem Dram Refresh Rate C845 Bios Token", "description": "CbsCmnMemDramRefreshRate bios token property.", "x-allOf-name": "bios.CbsCmnMemDramRefreshRateC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemDramRefreshRateC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemDramRefreshRateC845BiosToken" ], "default": "bios.CbsCmnMemDramRefreshRateC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemDramRefreshRateC845BiosToken" ], "default": "bios.CbsCmnMemDramRefreshRateC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "DRAM refresh rate: 1.95us or 3.9us (default).\n* `3.9 usec` - Value -- 3.9 usec for configuring CbsCmnMemDramRefreshRate token.\n* `1.95 usec` - Value -- 1.95 usec for configuring CbsCmnMemDramRefreshRate token.", "type": "string", "enum": [ "3.9 usec", "1.95 usec" ], "default": "3.9 usec", "x-omitempty": true } } } ] }, "bios.CbsCmnMemDramScrubTimeC845BiosToken": { "title": "Bios:Cbs Cmn Mem Dram Scrub Time C845 Bios Token", "description": "CbsCmnMemDramScrubTime bios token property.", "x-allOf-name": "bios.CbsCmnMemDramScrubTimeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemDramScrubTimeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemDramScrubTimeC845BiosToken" ], "default": "bios.CbsCmnMemDramScrubTimeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemDramScrubTimeC845BiosToken" ], "default": "bios.CbsCmnMemDramScrubTimeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Provide a value that is the number of hours to scrub memory.\n* `24 hours` - Value -- 24 hours for configuring CbsCmnMemDramScrubTime token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemDramScrubTime token.\n* `1 hour` - Value -- 1 hour for configuring CbsCmnMemDramScrubTime token.\n* `4 hours` - Value -- 4 hours for configuring CbsCmnMemDramScrubTime token.\n* `6 hours` - Value -- 6 hours for configuring CbsCmnMemDramScrubTime token.\n* `8 hours` - Value -- 8 hours for configuring CbsCmnMemDramScrubTime token.\n* `12 hours` - Value -- 12 hours for configuring CbsCmnMemDramScrubTime token.\n* `16 hours` - Value -- 16 hours for configuring CbsCmnMemDramScrubTime token.\n* `48 hours` - Value -- 48 hours for configuring CbsCmnMemDramScrubTime token.", "type": "string", "enum": [ "24 hours", "Disabled", "1 hour", "4 hours", "6 hours", "8 hours", "12 hours", "16 hours", "48 hours" ], "default": "24 hours", "x-omitempty": true } } } ] }, "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken": { "title": "Bios:Cbs Cmn Mem Healing Bist Enable Bit Mask Ddr C845 Bios Token", "description": "CbsCmnMemHealingBistEnableBitMaskDdr bios token property.", "x-allOf-name": "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken" ], "default": "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken" ], "default": "bios.CbsCmnMemHealingBistEnableBitMaskDdrC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "This item enables a full memory test. Please note that this is a memory content test and is separate and distinct from the MBIST test of Interface and Data Eye. PMU Mem BIST: this uses PMU firmware to test memory on all channels simultaneously. Failing memory will be repaired using soft or hard PPR depending on the PPR configuration. Self-Healing Mem BIST: this runs the JEDEC DRAM self healing, if the device and DIMM support the feature. The DRAM will do a hard repair for failing memory. PMU and Self-Healing Mem BIST: this option runs the PMU Mem BIST then the Self-Healing Mem BIST tests sequentially.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemHealingBistEnableBitMaskDdr token.\n* `PMU Mem BIST` - Value -- PMU Mem BIST for configuring CbsCmnMemHealingBistEnableBitMaskDdr token.\n* `Self-Healing Mem BIST` - Value -- Self-Healing Mem BIST for configuring CbsCmnMemHealingBistEnableBitMaskDdr token.\n* `PMU and Self-Healing Mem BIST` - Value -- PMU and Self-Healing Mem BIST for configuring CbsCmnMemHealingBistEnableBitMaskDdr token.", "type": "string", "enum": [ "Disabled", "PMU Mem BIST", "Self-Healing Mem BIST", "PMU and Self-Healing Mem BIST" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken": { "title": "Bios:Cbs Cmn Mem Healing Bist Execution Mode C845 Bios Token", "description": "CbsCmnMemHealingBistExecutionMode bios token property.", "x-allOf-name": "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemHealingBistExecutionModeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken" ], "default": "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken" ], "default": "bios.CbsCmnMemHealingBistExecutionModeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "[One Time]: DDR Healing BIST will only be executed one time. [Every Boot]: DDR Healing BIST will be executed on every boot.\n* `One Time` - Value -- One Time for configuring CbsCmnMemHealingBistExecutionMode token.\n* `Every Boot` - Value -- Every Boot for configuring CbsCmnMemHealingBistExecutionMode token.", "type": "string", "enum": [ "One Time", "Every Boot" ], "default": "One Time", "x-omitempty": true } } } ] }, "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken": { "title": "Bios:Cbs Cmn Mem Runtime Post Package Repair C845 Bios Token", "description": "CbsCmnMemRuntimePostPackageRepair bios token property.", "x-allOf-name": "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken" ], "default": "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken" ], "default": "bios.CbsCmnMemRuntimePostPackageRepairC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable DRAM Run Time Post Package Repair.\n* `Disable` - Value -- Disable for configuring CbsCmnMemRuntimePostPackageRepair token.\n* `Enable` - Value -- Enable for configuring CbsCmnMemRuntimePostPackageRepair token.", "type": "string", "enum": [ "Disable", "Enable" ], "default": "Disable", "x-omitempty": true } } } ] }, "bios.CbsCmnMemTsmeEnableDdrC845BiosToken": { "title": "Bios:Cbs Cmn Mem Tsme Enable Ddr C845 Bios Token", "description": "CbsCmnMemTsmeEnableDdr bios token property.", "x-allOf-name": "bios.CbsCmnMemTsmeEnableDdrC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnMemTsmeEnableDdrC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnMemTsmeEnableDdrC845BiosToken" ], "default": "bios.CbsCmnMemTsmeEnableDdrC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnMemTsmeEnableDdrC845BiosToken" ], "default": "bios.CbsCmnMemTsmeEnableDdrC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Transparent Secure Memory Encryption (TSME).\n* `Auto` - Value -- Auto for configuring CbsCmnMemTsmeEnableDdr token.\n* `Enabled` - Value -- Enabled for configuring CbsCmnMemTsmeEnableDdr token.\n* `Disabled` - Value -- Disabled for configuring CbsCmnMemTsmeEnableDdr token.", "type": "string", "enum": [ "Auto", "Enabled", "Disabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCmnPcieCaplinkSpeedC845BiosToken": { "title": "Bios:Cbs Cmn Pcie Caplink Speed C845 Bios Token", "description": "CbsCmnPcieCAPLinkSpeed bios token property.", "x-allOf-name": "bios.CbsCmnPcieCaplinkSpeedC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCmnPcieCaplinkSpeedC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCmnPcieCaplinkSpeedC845BiosToken" ], "default": "bios.CbsCmnPcieCaplinkSpeedC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCmnPcieCaplinkSpeedC845BiosToken" ], "default": "bios.CbsCmnPcieCaplinkSpeedC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Set all PCIe port speed capability.\n* `Auto` - Value -- Auto for configuring CbsCmnPcieCaplinkSpeed token.\n* `Maximum speed` - Value -- Maximum speed for configuring CbsCmnPcieCaplinkSpeed token.\n* `Gen1` - Value -- Gen1 for configuring CbsCmnPcieCaplinkSpeed token.\n* `Gen2` - Value -- Gen2 for configuring CbsCmnPcieCaplinkSpeed token.\n* `GEN3` - Value -- GEN3 for configuring CbsCmnPcieCaplinkSpeed token.\n* `GEN4` - Value -- GEN4 for configuring CbsCmnPcieCaplinkSpeed token.\n* `GEN5` - Value -- GEN5 for configuring CbsCmnPcieCaplinkSpeed token.", "type": "string", "enum": [ "Auto", "Maximum speed", "Gen1", "Gen2", "GEN3", "GEN4", "GEN5" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCpuCcdCtrlC845BiosToken": { "title": "Bios:Cbs Cpu Ccd Ctrl C845 Bios Token", "description": "CbsCpuCcdCtrl bios token property.", "x-allOf-name": "bios.CbsCpuCcdCtrlC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCpuCcdCtrlC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCpuCcdCtrlC845BiosToken" ], "default": "bios.CbsCpuCcdCtrlC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCpuCcdCtrlC845BiosToken" ], "default": "bios.CbsCpuCcdCtrlC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Sets the number of active CCDs. Once this option has been used to remove any CCDs, a POWER CYCLE is required in order for future selections to take effect.\n* `Auto` - Value -- Auto for configuring CbsCpuCcdCtrl token.\n* `2 CCDs` - Value -- 2 CCDs for configuring CbsCpuCcdCtrl token.\n* `4 CCDs` - Value -- 4 CCDs for configuring CbsCpuCcdCtrl token.\n* `6 CCDs` - Value -- 6 CCDs for configuring CbsCpuCcdCtrl token.\n* `8 CCDs` - Value -- 8 CCDs for configuring CbsCpuCcdCtrl token.\n* `10 CCDs` - Value -- 10 CCDs for configuring CbsCpuCcdCtrl token.\n* `12 CCDs` - Value -- 12 CCDs for configuring CbsCpuCcdCtrl token.\n* `14 CCDs` - Value -- 14 CCDs for configuring CbsCpuCcdCtrl token.", "type": "string", "enum": [ "Auto", "2 CCDs", "4 CCDs", "6 CCDs", "8 CCDs", "10 CCDs", "12 CCDs", "14 CCDs" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsCpuSmtCtrlC845BiosToken": { "title": "Bios:Cbs Cpu Smt Ctrl C845 Bios Token", "description": "CbsCpuSmtCtrl bios token property.", "x-allOf-name": "bios.CbsCpuSmtCtrlC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsCpuSmtCtrlC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsCpuSmtCtrlC845BiosToken" ], "default": "bios.CbsCpuSmtCtrlC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsCpuSmtCtrlC845BiosToken" ], "default": "bios.CbsCpuSmtCtrlC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Can be used to disable symmetric multithreading. To re-enable SMT, a POWER CYCLE is needed after selecting the 'Enable' option. Select 'Auto' based on BIOS PCD (PcdAmdSmtMode) default setting.\n* `Auto` - Value -- Auto for configuring CbsCpuSmtCtrl token.\n* `Disable` - Value -- Disable for configuring CbsCpuSmtCtrl token.\n* `Enable` - Value -- Enable for configuring CbsCpuSmtCtrl token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsDbgCpuLapicModeC845BiosToken": { "title": "Bios:Cbs Dbg Cpu Lapic Mode C845 Bios Token", "description": "CbsDbgCpuLApicMode bios token property.", "x-allOf-name": "bios.CbsDbgCpuLapicModeC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsDbgCpuLapicModeC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsDbgCpuLapicModeC845BiosToken" ], "default": "bios.CbsDbgCpuLapicModeC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsDbgCpuLapicModeC845BiosToken" ], "default": "bios.CbsDbgCpuLapicModeC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Select local APIC operation modes.\n* `Auto` - Value -- Auto for configuring CbsDbgCpuLapicMode token.\n* `xAPIC` - Value -- xAPIC for configuring CbsDbgCpuLapicMode token.\n* `x2APIC` - Value -- x2APIC for configuring CbsDbgCpuLapicMode token.", "type": "string", "enum": [ "Auto", "xAPIC", "x2APIC" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsDbgCpuSnpMemCoverC845BiosToken": { "title": "Bios:Cbs Dbg Cpu Snp Mem Cover C845 Bios Token", "description": "CbsDbgCpuSnpMemCover bios token property.", "x-allOf-name": "bios.CbsDbgCpuSnpMemCoverC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsDbgCpuSnpMemCoverC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsDbgCpuSnpMemCoverC845BiosToken" ], "default": "bios.CbsDbgCpuSnpMemCoverC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsDbgCpuSnpMemCoverC845BiosToken" ], "default": "bios.CbsDbgCpuSnpMemCoverC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enabled = ENTIRE system memory is covered.\n* `Auto` - Value -- Auto for configuring CbsDbgCpuSnpMemCover token.\n* `Disabled` - Value -- Disabled for configuring CbsDbgCpuSnpMemCover token.\n* `Enabled` - Value -- Enabled for configuring CbsDbgCpuSnpMemCover token.\n* `Custom` - Value -- Custom for configuring CbsDbgCpuSnpMemCover token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled", "Custom" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken": { "title": "Bios:Cbs Df Cmn3 Link Max Xgmi Speed C845 Bios Token", "description": "CbsDfCmn3LinkMaxXgmiSpeed bios token property.", "x-allOf-name": "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken" ], "default": "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken" ], "default": "bios.CbsDfCmn3LinkMaxXgmiSpeedC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Maximum frequency used for XGMI PState in a 3-link topology.\n* `Auto` - Value -- Auto for configuring CbsDfCmn3LinkMaxXgmiSpeed token.\n* `20Gbps` - Value -- 20Gbps for configuring CbsDfCmn3LinkMaxXgmiSpeed token.\n* `25Gbps` - Value -- 25Gbps for configuring CbsDfCmn3LinkMaxXgmiSpeed token.\n* `32Gbps` - Value -- 32Gbps for configuring CbsDfCmn3LinkMaxXgmiSpeed token.", "type": "string", "enum": [ "Auto", "20Gbps", "25Gbps", "32Gbps" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken": { "title": "Bios:Cbs Df Cmn Acpi Srat L3 Numa C845 Bios Token", "description": "CbsDfCmnAcpiSratL3Numa bios token property.", "x-allOf-name": "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsDfCmnAcpiSratL3NumaC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken" ], "default": "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken" ], "default": "bios.CbsDfCmnAcpiSratL3NumaC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enabled: Each CCX in the system will be declared as a separate NUMA domain. Disabled: Memory Addressing NUMA nodes per socket will be declared.\n* `Auto` - Value -- Auto for configuring CbsDfCmnAcpiSratL3Numa token.\n* `Disabled` - Value -- Disabled for configuring CbsDfCmnAcpiSratL3Numa token.\n* `Enabled` - Value -- Enabled for configuring CbsDfCmnAcpiSratL3Numa token.", "type": "string", "enum": [ "Auto", "Disabled", "Enabled" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsDfCmnDramNpsC845BiosToken": { "title": "Bios:Cbs Df Cmn Dram Nps C845 Bios Token", "description": "CbsDfCmnDramNps bios token property.", "x-allOf-name": "bios.CbsDfCmnDramNpsC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsDfCmnDramNpsC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsDfCmnDramNpsC845BiosToken" ], "default": "bios.CbsDfCmnDramNpsC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsDfCmnDramNpsC845BiosToken" ], "default": "bios.CbsDfCmnDramNpsC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "The number of desired NUMA nodes per socket. Zero will attempt to interleave the two sockets together.\n* `Auto` - Value -- Auto for configuring CbsDfCmnDramNps token.\n* `NPS0` - Value -- NPS0 for configuring CbsDfCmnDramNps token.\n* `NPS1` - Value -- NPS1 for configuring CbsDfCmnDramNps token.\n* `NPS2` - Value -- NPS2 for configuring CbsDfCmnDramNps token.\n* `NPS4` - Value -- NPS4 for configuring CbsDfCmnDramNps token.", "type": "string", "enum": [ "Auto", "NPS0", "NPS1", "NPS2", "NPS4" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.CbsSevSnpSupportC845BiosToken": { "title": "Bios:Cbs Sev Snp Support C845 Bios Token", "description": "CbsSevSnpSupport bios token property.", "x-allOf-name": "bios.CbsSevSnpSupportC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.CbsSevSnpSupportC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.CbsSevSnpSupportC845BiosToken" ], "default": "bios.CbsSevSnpSupportC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.CbsSevSnpSupportC845BiosToken" ], "default": "bios.CbsSevSnpSupportC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enables support for Secure Encrypted Virtualization and Secure Nested Paging.\n* `Auto` - Value -- Auto for configuring CbsSevSnpSupport token.\n* `Disable` - Value -- Disable for configuring CbsSevSnpSupport token.\n* `Enable` - Value -- Enable for configuring CbsSevSnpSupport token.", "type": "string", "enum": [ "Auto", "Disable", "Enable" ], "default": "Auto", "x-omitempty": true } } } ] }, "bios.Cpu005C845BiosToken": { "title": "Bios:Cpu005 C845 Bios Token", "description": "CPU005 bios token property.", "x-allOf-name": "bios.Cpu005C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Cpu005C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Cpu005C845BiosToken" ], "default": "bios.Cpu005C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Cpu005C845BiosToken" ], "default": "bios.Cpu005C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/disable CPU Virtualization.\n* `Enabled` - Value -- Enabled for configuring Cpu005 token.\n* `Disabled` - Value -- Disabled for configuring Cpu005 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Ipmi100C845BiosToken": { "title": "Bios:Ipmi100 C845 Bios Token", "description": "IPMI100 bios token property.", "x-allOf-name": "bios.Ipmi100C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ipmi100C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ipmi100C845BiosToken" ], "default": "bios.Ipmi100C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ipmi100C845BiosToken" ], "default": "bios.Ipmi100C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable FRB-2 timer (POST timer).\n* `Enabled` - Value -- Enabled for configuring Ipmi100 token.\n* `Disabled` - Value -- Disabled for configuring Ipmi100 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Ipmi103C845BiosToken": { "title": "Bios:Ipmi103 C845 Bios Token", "description": "IPMI103 bios token property.", "x-allOf-name": "bios.Ipmi103C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ipmi103C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ipmi103C845BiosToken" ], "default": "bios.Ipmi103C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ipmi103C845BiosToken" ], "default": "bios.Ipmi103C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "If enabled, starts a BIOS timer which can only be shut off by Management Software after the OS loads. Helps determine that the OS successfully loaded or follows the OS Boot Watchdog Timer policy.\n* `Disabled` - Value -- Disabled for configuring Ipmi103 token.\n* `Enabled` - Value -- Enabled for configuring Ipmi103 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.Ipmi104C845BiosToken": { "title": "Bios:Ipmi104 C845 Bios Token", "description": "Enter the value Between 1 to 30 min for OS Boot Watchdog Timer Expiration. Not available if OS Boot Watchdog Timer is disabled.", "x-allOf-name": "bios.Ipmi104C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ipmi104C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ipmi104C845BiosToken" ], "default": "bios.Ipmi104C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ipmi104C845BiosToken" ], "default": "bios.Ipmi104C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enter the value Between 1 to 30 min for OS Boot Watchdog Timer Expiration. Not available if OS Boot Watchdog Timer is disabled.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 30, "x-omitempty": true } } } ] }, "bios.Ipmi105C845BiosToken": { "title": "Bios:Ipmi105 C845 Bios Token", "description": "IPMI105 bios token property.", "x-allOf-name": "bios.Ipmi105C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ipmi105C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ipmi105C845BiosToken" ], "default": "bios.Ipmi105C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ipmi105C845BiosToken" ], "default": "bios.Ipmi105C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Configure how the system should respond if the OS Boot Watchdog Timer expires. Not available if OS Boot Watchdog Timer is disabled.\n* `Reset` - Value -- Reset for configuring Ipmi105 token.\n* `Do Nothing` - Value -- Do Nothing for configuring Ipmi105 token.\n* `Power Down` - Value -- Power Down for configuring Ipmi105 token.\n* `Power Cycle` - Value -- Power Cycle for configuring Ipmi105 token.", "type": "string", "enum": [ "Reset", "Do Nothing", "Power Down", "Power Cycle" ], "default": "Reset", "x-omitempty": true } } } ] }, "bios.Nvlck002C845BiosToken": { "title": "Bios:Nvlck002 C845 Bios Token", "description": "NVLCK002 bios token property.", "x-allOf-name": "bios.Nvlck002C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Nvlck002C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Nvlck002C845BiosToken" ], "default": "bios.Nvlck002C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Nvlck002C845BiosToken" ], "default": "bios.Nvlck002C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Control the NVRAM Runtime Variable protection through System Admin Password.\n* `Enabled` - Value -- Enabled for configuring Nvlck002 token.\n* `Disabled` - Value -- Disabled for configuring Nvlck002 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Nwsk001C845BiosToken": { "title": "Bios:Nwsk001 C845 Bios Token", "description": "NWSK001 bios token property.", "x-allOf-name": "bios.Nwsk001C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Nwsk001C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Nwsk001C845BiosToken" ], "default": "bios.Nwsk001C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Nwsk001C845BiosToken" ], "default": "bios.Nwsk001C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/Disable IPv4 PXE boot support. If disabled, IPv4 PXE boot support will not be available.\n* `Enabled` - Value -- Enabled for configuring Nwsk001 token.\n* `Disabled` - Value -- Disabled for configuring Nwsk001 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Nwsk002C845BiosToken": { "title": "Bios:Nwsk002 C845 Bios Token", "description": "NWSK002 bios token property.", "x-allOf-name": "bios.Nwsk002C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Nwsk002C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Nwsk002C845BiosToken" ], "default": "bios.Nwsk002C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Nwsk002C845BiosToken" ], "default": "bios.Nwsk002C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/Disable IPv6 PXE boot support. If disabled, IPv6 PXE boot support will not be available.\n* `Disabled` - Value -- Disabled for configuring Nwsk002 token.\n* `Enabled` - Value -- Enabled for configuring Nwsk002 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.Nwsk006C845BiosToken": { "title": "Bios:Nwsk006 C845 Bios Token", "description": "NWSK006 bios token property.", "x-allOf-name": "bios.Nwsk006C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Nwsk006C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Nwsk006C845BiosToken" ], "default": "bios.Nwsk006C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Nwsk006C845BiosToken" ], "default": "bios.Nwsk006C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/Disable IPv4 HTTP boot support. If disabled, IPv4 HTTP boot support will not be available.\n* `Enabled` - Value -- Enabled for configuring Nwsk006 token.\n* `Disabled` - Value -- Disabled for configuring Nwsk006 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Nwsk007C845BiosToken": { "title": "Bios:Nwsk007 C845 Bios Token", "description": "NWSK007 bios token property.", "x-allOf-name": "bios.Nwsk007C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Nwsk007C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Nwsk007C845BiosToken" ], "default": "bios.Nwsk007C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Nwsk007C845BiosToken" ], "default": "bios.Nwsk007C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/Disable IPv6 HTTP boot support. If disabled, IPv6 HTTP boot support will not be available.\n* `Disabled` - Value -- Disabled for configuring Nwsk007 token.\n* `Enabled` - Value -- Enabled for configuring Nwsk007 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.Pcid001C845BiosToken": { "title": "Bios:Pcid001 C845 Bios Token", "description": "PCID001 bios token property.", "x-allOf-name": "bios.Pcid001C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Pcid001C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Pcid001C845BiosToken" ], "default": "bios.Pcid001C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Pcid001C845BiosToken" ], "default": "bios.Pcid001C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Globally Enables or Disables 64bit capable Devices to be Decoded in Above 4G Address Space (Only if System Supports 64 bit PCI Decoding).\n* `Enabled` - Value -- Enabled for configuring Pcid001 token.", "type": "string", "enum": [ "Enabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Pcid002C845BiosToken": { "title": "Bios:Pcid002 C845 Bios Token", "description": "PCID002 bios token property.", "x-allOf-name": "bios.Pcid002C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Pcid002C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Pcid002C845BiosToken" ], "default": "bios.Pcid002C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Pcid002C845BiosToken" ], "default": "bios.Pcid002C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "If system has SR-IOV capable PCIe Devices, this option Enables or Disables Single Root IO Virtualization Support.\n* `Enabled` - Value -- Enabled for configuring Pcid002 token.\n* `Disabled` - Value -- Disabled for configuring Pcid002 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Pcid003C845BiosToken": { "title": "Bios:Pcid003 C845 Bios Token", "description": "PCID003 bios token property.", "x-allOf-name": "bios.Pcid003C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Pcid003C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Pcid003C845BiosToken" ], "default": "bios.Pcid003C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Pcid003C845BiosToken" ], "default": "bios.Pcid003C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Re-enable Bus Initiator Attribute disabled during Pci enumeration for PCI Bridges after SMM Locked.\n* `Disabled` - Value -- Disabled for configuring Pcid003 token.\n* `Enabled` - Value -- Enabled for configuring Pcid003 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.Policy.Response": { "description": "The response body of a HTTP GET request for the 'bios.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.Policy' resources.", "x-one-of-name": "bios.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.Policy": { "title": "BIOS", "description": "The BIOS Policy object is a reusable policy for configuring a comprehensive set of low-level system settings, known as BIOS tokens, on a server.\n#### Purpose\nThe purpose of a BIOS Policy is to standardize and automate the configuration of server BIOS settings at scale. Instead of manually configuring each server's BIOS, administrators can define a single policy with desired settings for performance, power management, boot options, and device configuration, and apply it consistently across multiple servers through profiles.\n#### Key Concepts\n- **Token-Based Configuration:** The policy exposes a wide array of BIOS settings as individual \"tokens\" (properties) that can be enabled, disabled, or set to specific values.\n- **Reusable and Enforceable:** As a policy object, it can be attached to multiple server profiles, ensuring that all associated servers maintain a consistent BIOS configuration.\n- **Profile-Based Application:** It is designed to be included in a Server Profile, which then applies the configuration to the assigned physical server.\n- **Reboot Required:** Changes to the BIOS policy are flagged with ActivationRequiresReboot, indicating that a server reboot is necessary for the new settings to take effect.\n- **Organization-Owned:** The policy is managed at the organization level, allowing for standardized configurations across different teams or environments.\n- **Cisco Provided Configuration:** Pre-configured settings available to be selected for specific workloads like Cpu Intensive, Computation Intensive, Analytics etc for specific server models.", "x-allOf-name": "bios.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Policy" ], "default": "bios.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Policy" ], "default": "bios.Policy", "x-enum-as-string": true }, "AcpiSratSpFlagEn": { "description": "BIOS Token for setting ACPI SRAT Special Purpose Memory Flag configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu1state": { "description": "BIOS Token for setting ACS Control GPU 1 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu2state": { "description": "BIOS Token for setting ACS Control GPU 2 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu3state": { "description": "BIOS Token for setting ACS Control GPU 3 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu4state": { "description": "BIOS Token for setting ACS Control GPU 4 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu5state": { "description": "BIOS Token for setting ACS Control GPU 5 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu6state": { "description": "BIOS Token for setting ACS Control GPU 6 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu7state": { "description": "BIOS Token for setting ACS Control GPU 7 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlGpu8state": { "description": "BIOS Token for setting ACS Control GPU 8 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlSlot11state": { "description": "BIOS Token for setting ACS Control Slot 11 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlSlot12state": { "description": "BIOS Token for setting ACS Control Slot 12 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlSlot13state": { "description": "BIOS Token for setting ACS Control Slot 13 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AcsControlSlot14state": { "description": "BIOS Token for setting ACS Control Slot 14 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AdaptiveRefreshMgmtLevel": { "description": "BIOS Token for setting Adaptive Refresh Management Level configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Default` - Value - Default for configuring AdaptiveRefreshMgmtLevel token.\n* `Level A` - Value - Level A for configuring AdaptiveRefreshMgmtLevel token.\n* `Level B` - Value - Level B for configuring AdaptiveRefreshMgmtLevel token.\n* `Level C` - Value - Level C for configuring AdaptiveRefreshMgmtLevel token.", "type": "string", "enum": [ "platform-default", "Default", "Level A", "Level B", "Level C" ], "default": "platform-default", "x-omitempty": true }, "AdjacentCacheLinePrefetch": { "description": "BIOS Token for setting Adjacent Cache Line Prefetcher configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AdvancedMemTest": { "description": "BIOS Token for setting Enhanced Memory Test configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring AdvancedMemTest token.\n* `disabled` - Value - disabled for configuring AdvancedMemTest token.\n* `enabled` - Value - enabled for configuring AdvancedMemTest token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "AllUsbDevices": { "description": "BIOS Token for setting All USB Devices configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Altitude": { "description": "BIOS Token for setting Altitude configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `300-m` - Value - 300-m for configuring Altitude token.\n* `900-m` - Value - 900-m for configuring Altitude token.\n* `1500-m` - Value - 1500-m for configuring Altitude token.\n* `3000-m` - Value - 3000-m for configuring Altitude token.\n* `auto` - Value - auto for configuring Altitude token.", "type": "string", "enum": [ "platform-default", "300-m", "900-m", "1500-m", "3000-m", "auto" ], "default": "platform-default", "x-omitempty": true }, "AspmSupport": { "description": "BIOS Token for setting ASPM Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring AspmSupport token.\n* `Disabled` - Value - Disabled for configuring AspmSupport token.\n* `Force L0s` - Value - Force L0s for configuring AspmSupport token.\n* `L1 Only` - Value - L1 Only for configuring AspmSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "Force L0s", "L1 Only" ], "default": "platform-default", "x-omitempty": true }, "AssertNmiOnPerr": { "description": "BIOS Token for setting Assert NMI on PERR configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AssertNmiOnSerr": { "description": "BIOS Token for setting Assert NMI on SERR configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AutoCcState": { "description": "BIOS Token for setting Autonomous Core C State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "AutonumousCstateEnable": { "description": "BIOS Token for setting CPU Autonomous C State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "BaudRate": { "description": "BIOS Token for setting Baud Rate configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `9600` - Value - 9600 for configuring BaudRate token.\n* `19200` - Value - 19200 for configuring BaudRate token.\n* `38400` - Value - 38400 for configuring BaudRate token.\n* `57600` - Value - 57600 for configuring BaudRate token.\n* `115200` - Value - 115200 for configuring BaudRate token.", "type": "string", "enum": [ "platform-default", "9600", "19200", "38400", "57600", "115200" ], "default": "platform-default", "x-omitempty": true }, "BiosConfigurations": { "type": "array", "items": { "description": "Collection for holding all the BIOS configurations.", "$ref": "#/components/schemas/bios.BaseBiosConfiguration", "x-omitempty": true }, "nullable": true }, "BmeDmaMitigation": { "description": "BIOS Token for setting BME DMA Mitigation configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "BootOptionNumRetry": { "description": "BIOS Token for setting Number of Retries configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `5` - Value - 5 for configuring BootOptionNumRetry token.\n* `13` - Value - 13 for configuring BootOptionNumRetry token.\n* `Infinite` - Value - Infinite for configuring BootOptionNumRetry token.", "type": "string", "enum": [ "platform-default", "5", "13", "Infinite" ], "default": "platform-default", "x-omitempty": true }, "BootOptionReCoolDown": { "description": "BIOS Token for setting Cool Down Time (sec) configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `15` - Value - 15 for configuring BootOptionReCoolDown token.\n* `45` - Value - 45 for configuring BootOptionReCoolDown token.\n* `90` - Value - 90 for configuring BootOptionReCoolDown token.", "type": "string", "enum": [ "platform-default", "15", "45", "90" ], "default": "platform-default", "x-omitempty": true }, "BootOptionRetry": { "description": "BIOS Token for setting Boot Option Retry configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "BootPerformanceMode": { "description": "BIOS Token for setting Boot Performance Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Max Efficient` - Value - Max Efficient for configuring BootPerformanceMode token.\n* `Max Performance` - Value - Max Performance for configuring BootPerformanceMode token.\n* `Set by Intel NM` - Value - Set by Intel NM for configuring BootPerformanceMode token.", "type": "string", "enum": [ "platform-default", "Max Efficient", "Max Performance", "Set by Intel NM" ], "default": "platform-default", "x-omitempty": true }, "BurstAndPostponedRefresh": { "description": "BIOS Token for setting Burst and Postponed Refresh configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "C1autoDemotion": { "description": "BIOS Token for setting C1 Auto Demotion configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring C1autoDemotion token.\n* `disabled` - Value - disabled for configuring C1autoDemotion token.\n* `enabled` - Value - enabled for configuring C1autoDemotion token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "C1autoUnDemotion": { "description": "BIOS Token for setting C1 Auto UnDemotion configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring C1autoUnDemotion token.\n* `disabled` - Value - disabled for configuring C1autoUnDemotion token.\n* `enabled` - Value - enabled for configuring C1autoUnDemotion token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnApbdis": { "description": "BIOS Token for setting APBDIS configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `0` - Value - 0 for configuring CbsCmnApbdis token.\n* `1` - Value - 1 for configuring CbsCmnApbdis token.\n* `Auto` - Value - Auto for configuring CbsCmnApbdis token.", "type": "string", "enum": [ "platform-default", "0", "1", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnApbdisDfPstateRs": { "description": "BIOS Token for setting Fixed SOC P-State SP5 F19h configuration (0 - 2 P State).", "type": "string", "default": "platform-default", "pattern": "^([0-2])$|^(platform-default)$", "x-omitempty": true }, "CbsCmnCpuAvx512": { "description": "BIOS Token for setting AVX512 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuAvx512 token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuAvx512 token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuAvx512 token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuCpb": { "description": "BIOS Token for setting Core Performance Boost configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuCpb token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuCpb token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuFrequencyControl": { "description": "BIOS Token for setting CPU Frequency Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuFrequencyControl token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuFrequencyControl token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuFrequencyControl token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuGenDowncoreCtrl": { "description": "BIOS Token for setting Downcore Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `TWO (1 + 1)` - Value - TWO (1 + 1) for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `FOUR (2 + 2)` - Value - FOUR (2 + 2) for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `TWO (2 + 0)` - Value - TWO (2 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `SIX (3 + 3)` - Value - SIX (3 + 3) for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `THREE (3 + 0)` - Value - THREE (3 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token.\n* `FOUR (4 + 0)` - Value - FOUR (4 + 0) for configuring CbsCmnCpuGenDowncoreCtrl token.", "type": "string", "enum": [ "platform-default", "Auto", "TWO (1 + 1)", "FOUR (2 + 2)", "TWO (2 + 0)", "SIX (3 + 3)", "THREE (3 + 0)", "FOUR (4 + 0)" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuGlobalCstateCtrl": { "description": "BIOS Token for setting Global C State Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuGlobalCstateCtrl token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuGlobalCstateCtrl token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuGlobalCstateCtrl token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuL1streamHwPrefetcher": { "description": "BIOS Token for setting L1 Stream HW Prefetcher configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuL1streamHwPrefetcher token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuL1streamHwPrefetcher token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuL1streamHwPrefetcher token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuL2streamHwPrefetcher": { "description": "BIOS Token for setting L2 Stream HW Prefetcher configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuL2streamHwPrefetcher token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuL2streamHwPrefetcher token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuL2streamHwPrefetcher token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuSevAsidSpaceLimit": { "description": "BIOS Token for setting SEV-ES ASID Space Limit configuration (1 - 1007 ASIDs).", "type": "string", "default": "platform-default", "pattern": "^([1-9]|[1-9]\\d|[1-9]\\d{2}|100[0-7])$|^(platform-default)$", "x-omitempty": true }, "CbsCmnCpuSmee": { "description": "BIOS Token for setting CPU SMEE configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuSmee token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuSmee token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuSmee token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnCpuStreamingStoresCtrl": { "description": "BIOS Token for setting Streaming Stores Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnCpuStreamingStoresCtrl token.\n* `disabled` - Value - disabled for configuring CbsCmnCpuStreamingStoresCtrl token.\n* `enabled` - Value - enabled for configuring CbsCmnCpuStreamingStoresCtrl token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnDeterminismSlider": { "description": "BIOS Token for setting Determinism Slider configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnDeterminismSlider token.\n* `Performance` - Value - Performance for configuring CbsCmnDeterminismSlider token.\n* `Power` - Value - Power for configuring CbsCmnDeterminismSlider token.", "type": "string", "enum": [ "platform-default", "Auto", "Performance", "Power" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnEdcControlThrottle": { "description": "BIOS Token for setting EDC Control Throttle configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnEdcControlThrottle token.\n* `disabled` - Value - disabled for configuring CbsCmnEdcControlThrottle token.\n* `enabled` - Value - enabled for configuring CbsCmnEdcControlThrottle token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnEfficiencyModeEn": { "description": "BIOS Token for setting Efficiency Mode Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnEfficiencyModeEn token.\n* `Enabled` - Value - Enabled for configuring CbsCmnEfficiencyModeEn token.", "type": "string", "enum": [ "platform-default", "Auto", "Enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnEfficiencyModeEnRs": { "description": "BIOS Token for setting Power Profile Selection F19h configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnEfficiencyModeEnRs token.\n* `Balanced Core Memory Performance Mode` - Value - Balanced Core Memory Performance Mode for configuring CbsCmnEfficiencyModeEnRs token.\n* `Balanced Core Performance Mode` - Value - Balanced Core Performance Mode for configuring CbsCmnEfficiencyModeEnRs token.\n* `Balanced Memory Performance Mode` - Value - Balanced Memory Performance Mode for configuring CbsCmnEfficiencyModeEnRs token.\n* `Efficiency Mode` - Value - Efficiency Mode for configuring CbsCmnEfficiencyModeEnRs token.\n* `High Performance Mode` - Value - High Performance Mode for configuring CbsCmnEfficiencyModeEnRs token.\n* `Maximum IO Performance Mode` - Value - Maximum IO Performance Mode for configuring CbsCmnEfficiencyModeEnRs token.", "type": "string", "enum": [ "platform-default", "Auto", "Balanced Core Memory Performance Mode", "Balanced Core Performance Mode", "Balanced Memory Performance Mode", "Efficiency Mode", "High Performance Mode", "Maximum IO Performance Mode" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnFixedSocPstate": { "description": "BIOS Token for setting Fixed SOC P-State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnFixedSocPstate token.\n* `P0` - Value - P0 for configuring CbsCmnFixedSocPstate token.\n* `P1` - Value - P1 for configuring CbsCmnFixedSocPstate token.\n* `P2` - Value - P2 for configuring CbsCmnFixedSocPstate token.\n* `P3` - Value - P3 for configuring CbsCmnFixedSocPstate token.", "type": "string", "enum": [ "platform-default", "Auto", "P0", "P1", "P2", "P3" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnGnbNbIommu": { "description": "BIOS Token for setting IOMMU configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnGnbNbIommu token.\n* `disabled` - Value - disabled for configuring CbsCmnGnbNbIommu token.\n* `enabled` - Value - enabled for configuring CbsCmnGnbNbIommu token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnGnbSmuDfCstates": { "description": "BIOS Token for setting DF C-States configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnGnbSmuDfCstates token.\n* `disabled` - Value - disabled for configuring CbsCmnGnbSmuDfCstates token.\n* `enabled` - Value - enabled for configuring CbsCmnGnbSmuDfCstates token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnGnbSmuDffoRs": { "description": "BIOS Token for setting DF PState Frequency Optimizer configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnGnbSmuDffoRs token.\n* `disabled` - Value - disabled for configuring CbsCmnGnbSmuDffoRs token.\n* `enabled` - Value - enabled for configuring CbsCmnGnbSmuDffoRs token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnGnbSmuDlwmSupport": { "description": "BIOS Token for setting DLWM Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnGnbSmuDlwmSupport token.\n* `disabled` - Value - disabled for configuring CbsCmnGnbSmuDlwmSupport token.\n* `enabled` - Value - enabled for configuring CbsCmnGnbSmuDlwmSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnGnbSmucppc": { "description": "BIOS Token for setting CPPC configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnGnbSmucppc token.\n* `disabled` - Value - disabled for configuring CbsCmnGnbSmucppc token.\n* `enabled` - Value - enabled for configuring CbsCmnGnbSmucppc token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnMemCtrlBankGroupSwapDdr4": { "description": "BIOS Token for setting Bank Group Swap configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token.\n* `disabled` - Value - disabled for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token.\n* `enabled` - Value - enabled for configuring CbsCmnMemCtrlBankGroupSwapDdr4 token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnMemCtrllerPwrDnEnDdr": { "description": "BIOS Token for setting Power Down Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnMemCtrllerPwrDnEnDdr token.\n* `disabled` - Value - disabled for configuring CbsCmnMemCtrllerPwrDnEnDdr token.\n* `enabled` - Value - enabled for configuring CbsCmnMemCtrllerPwrDnEnDdr token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnMemMapBankInterleaveDdr4": { "description": "BIOS Token for setting Chipset Interleave configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnMemMapBankInterleaveDdr4 token.\n* `disabled` - Value - disabled for configuring CbsCmnMemMapBankInterleaveDdr4 token.\n* `Enabled` - Value - Enabled for configuring CbsCmnMemMapBankInterleaveDdr4 token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "Enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnMemSpeedDdr47xx2": { "description": "BIOS Token for setting Memory Clock Speed 7xx2 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `667MHz` - Value - 667MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `800MHz` - Value - 800MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `933MHz` - Value - 933MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `1067MHz` - Value - 1067MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `1200MHz` - Value - 1200MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `1333MHz` - Value - 1333MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `1467MHz` - Value - 1467MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `1600MHz` - Value - 1600MHz for configuring CbsCmnMemSpeedDdr47xx2 token.\n* `Auto` - Value - Auto for configuring CbsCmnMemSpeedDdr47xx2 token.", "type": "string", "enum": [ "platform-default", "667MHz", "800MHz", "933MHz", "1067MHz", "1200MHz", "1333MHz", "1467MHz", "1600MHz", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnMemSpeedDdr47xx3": { "description": "BIOS Token for setting Memory Clock Speed 7xx3 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `400MHz` - Value - 400MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `800MHz` - Value - 800MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `933MHz` - Value - 933MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1067MHz` - Value - 1067MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1200MHz` - Value - 1200MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1333MHz` - Value - 1333MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1467MHz` - Value - 1467MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1600MHz` - Value - 1600MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1633MHz` - Value - 1633MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1667MHz` - Value - 1667MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1700MHz` - Value - 1700MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1733MHz` - Value - 1733MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1767MHz` - Value - 1767MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `1800MHz` - Value - 1800MHz for configuring CbsCmnMemSpeedDdr47xx3 token.\n* `Auto` - Value - Auto for configuring CbsCmnMemSpeedDdr47xx3 token.", "type": "string", "enum": [ "platform-default", "400MHz", "800MHz", "933MHz", "1067MHz", "1200MHz", "1333MHz", "1467MHz", "1600MHz", "1633MHz", "1667MHz", "1700MHz", "1733MHz", "1767MHz", "1800MHz", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnPreferredIo7xx2": { "description": "BIOS Token for setting Preferred IO 7xx2 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnPreferredIo7xx2 token.\n* `Manual` - Value - Manual for configuring CbsCmnPreferredIo7xx2 token.", "type": "string", "enum": [ "platform-default", "Auto", "Manual" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnPreferredIo7xx3": { "description": "BIOS Token for setting Preferred IO 7xx3 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmnPreferredIo7xx3 token.\n* `Bus` - Value - Bus for configuring CbsCmnPreferredIo7xx3 token.", "type": "string", "enum": [ "platform-default", "Auto", "Bus" ], "default": "platform-default", "x-omitempty": true }, "CbsCmncTdpCtl": { "description": "BIOS Token for setting cTDP Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCmncTdpCtl token.\n* `Manual` - Value - Manual for configuring CbsCmncTdpCtl token.", "type": "string", "enum": [ "platform-default", "Auto", "Manual" ], "default": "platform-default", "x-omitempty": true }, "CbsCmnxGmiForceLinkWidthRs": { "description": "BIOS Token for setting xGMI Force Link Width configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `0` - Value - 0 for configuring CbsCmnxGmiForceLinkWidthRs token.\n* `1` - Value - 1 for configuring CbsCmnxGmiForceLinkWidthRs token.\n* `2` - Value - 2 for configuring CbsCmnxGmiForceLinkWidthRs token.\n* `Auto` - Value - Auto for configuring CbsCmnxGmiForceLinkWidthRs token.", "type": "string", "enum": [ "platform-default", "0", "1", "2", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsCpuCcdCtrlSsp": { "description": "BIOS Token for setting CCD Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `2 CCDs` - Value - 2 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `3 CCDs` - Value - 3 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `4 CCDs` - Value - 4 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `6 CCDs` - Value - 6 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `8 CCDs` - Value - 8 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `10 CCDs` - Value - 10 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `12 CCDs` - Value - 12 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `14 CCDs` - Value - 14 CCDs for configuring CbsCpuCcdCtrlSsp token.\n* `Auto` - Value - Auto for configuring CbsCpuCcdCtrlSsp token.", "type": "string", "enum": [ "platform-default", "2 CCDs", "3 CCDs", "4 CCDs", "6 CCDs", "8 CCDs", "10 CCDs", "12 CCDs", "14 CCDs", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsCpuCoreCtrl": { "description": "BIOS Token for setting CPU Downcore control 7xx3 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCpuCoreCtrl token.\n* `ONE (1 + 0)` - Value - ONE (1 + 0) for configuring CbsCpuCoreCtrl token.\n* `TWO (2 + 0)` - Value - TWO (2 + 0) for configuring CbsCpuCoreCtrl token.\n* `THREE (3 + 0)` - Value - THREE (3 + 0) for configuring CbsCpuCoreCtrl token.\n* `FOUR (4 + 0)` - Value - FOUR (4 + 0) for configuring CbsCpuCoreCtrl token.\n* `FIVE (5 + 0)` - Value - FIVE (5 + 0) for configuring CbsCpuCoreCtrl token.\n* `SIX (6 + 0)` - Value - SIX (6 + 0) for configuring CbsCpuCoreCtrl token.\n* `SEVEN (7 + 0)` - Value - SEVEN (7 + 0) for configuring CbsCpuCoreCtrl token.", "type": "string", "enum": [ "platform-default", "Auto", "ONE (1 + 0)", "TWO (2 + 0)", "THREE (3 + 0)", "FOUR (4 + 0)", "FIVE (5 + 0)", "SIX (6 + 0)", "SEVEN (7 + 0)" ], "default": "platform-default", "x-omitempty": true }, "CbsCpuDownCoreCtrlBergamo": { "description": "BIOS Token for setting Downcore control F19 MA0h-AFh configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCpuDownCoreCtrlBergamo token.\n* `TWO (1 + 1)` - Value - TWO (1 + 1) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `FOUR (2 + 2)` - Value - FOUR (2 + 2) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `SIX (3 + 3)` - Value - SIX (3 + 3) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `EIGHT (4 + 4)` - Value - EIGHT (4 + 4) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `TEN (5 + 5)` - Value - TEN (5 + 5) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `TWELVE (6 + 6)` - Value - TWELVE (6 + 6) for configuring CbsCpuDownCoreCtrlBergamo token.\n* `FOURTEEN (7 + 7)` - Value - FOURTEEN (7 + 7) for configuring CbsCpuDownCoreCtrlBergamo token.", "type": "string", "enum": [ "platform-default", "Auto", "TWO (1 + 1)", "FOUR (2 + 2)", "SIX (3 + 3)", "EIGHT (4 + 4)", "TEN (5 + 5)", "TWELVE (6 + 6)", "FOURTEEN (7 + 7)" ], "default": "platform-default", "x-omitempty": true }, "CbsCpuDownCoreCtrlGenoa": { "description": "BIOS Token for setting CPU Downcore control F19 M10h-1Fh configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCpuDownCoreCtrlGenoa token.\n* `ONE (1 + 0)` - Value - ONE (1 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `TWO (2 + 0)` - Value - TWO (2 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `THREE (3 + 0)` - Value - THREE (3 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `FOUR (4 + 0)` - Value - FOUR (4 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `FIVE (5 + 0)` - Value - FIVE (5 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `SIX (6 + 0)` - Value - SIX (6 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `SEVEN (7 + 0)` - Value - SEVEN (7 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `EIGHT (8 + 0)` - Value - EIGHT (8 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `NINE (9 + 0)` - Value - NINE (9 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `TEN (10 + 0)` - Value - TEN (10 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `ELEVEN (11 + 0)` - Value - ELEVEN (11 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `TWELVE (12 + 0)` - Value - TWELVE (12 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `THIRTEEN (13 + 0)` - Value - THIRTEEN (13 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `FOURTEEN (14 + 0)` - Value - FOURTEEN (14 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.\n* `FIFTEEN (15 + 0)` - Value - FIFTEEN (15 + 0) for configuring CbsCpuDownCoreCtrlGenoa token.", "type": "string", "enum": [ "platform-default", "Auto", "ONE (1 + 0)", "TWO (2 + 0)", "THREE (3 + 0)", "FOUR (4 + 0)", "FIVE (5 + 0)", "SIX (6 + 0)", "SEVEN (7 + 0)", "EIGHT (8 + 0)", "NINE (9 + 0)", "TEN (10 + 0)", "ELEVEN (11 + 0)", "TWELVE (12 + 0)", "THIRTEEN (13 + 0)", "FOURTEEN (14 + 0)", "FIFTEEN (15 + 0)" ], "default": "platform-default", "x-omitempty": true }, "CbsCpuSmtCtrl": { "description": "BIOS Token for setting CPU SMT Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsCpuSmtCtrl token.\n* `disabled` - Value - disabled for configuring CbsCpuSmtCtrl token.\n* `enabled` - Value - enabled for configuring CbsCpuSmtCtrl token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDbgCpuGenCpuWdt": { "description": "BIOS Token for setting Core Watchdog Timer Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDbgCpuGenCpuWdt token.\n* `disabled` - Value - disabled for configuring CbsDbgCpuGenCpuWdt token.\n* `enabled` - Value - enabled for configuring CbsDbgCpuGenCpuWdt token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDbgCpuLapicMode": { "description": "BIOS Token for setting Local APIC Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDbgCpuLapicMode token.\n* `Compatibility` - Value - Compatibility for configuring CbsDbgCpuLapicMode token.\n* `X2APIC` - Value - X2APIC for configuring CbsDbgCpuLapicMode token.\n* `XAPIC` - Value - XAPIC for configuring CbsDbgCpuLapicMode token.", "type": "string", "enum": [ "platform-default", "Auto", "Compatibility", "X2APIC", "XAPIC" ], "default": "platform-default", "x-omitempty": true }, "CbsDbgCpuSnpMemCover": { "description": "BIOS Token for setting SNP Memory Coverage configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDbgCpuSnpMemCover token.\n* `Custom` - Value - Custom for configuring CbsDbgCpuSnpMemCover token.\n* `disabled` - Value - disabled for configuring CbsDbgCpuSnpMemCover token.\n* `enabled` - Value - enabled for configuring CbsDbgCpuSnpMemCover token.", "type": "string", "enum": [ "platform-default", "Auto", "Custom", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDbgCpuSnpMemSizeCover": { "description": "BIOS Token for setting SNP Memory Size to Cover in MiB configuration (0 - 1048576 MiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-9]\\d{4}|[1-9]\\d{5}|10[0-3]\\d{4}|104[0-7]\\d{3}|1048[0-4]\\d{2}|10485[0-6]\\d|104857[0-6])$|^(platform-default)$", "x-omitempty": true }, "CbsDfCmn4linkMaxXgmiSpeed": { "description": "BIOS Token for setting 4-link xGMI max speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `20Gbps` - Value - 20Gbps for configuring CbsDfCmn4linkMaxXgmiSpeed token.\n* `25Gbps` - Value - 25Gbps for configuring CbsDfCmn4linkMaxXgmiSpeed token.\n* `32Gbps` - Value - 32Gbps for configuring CbsDfCmn4linkMaxXgmiSpeed token.\n* `Auto` - Value - Auto for configuring CbsDfCmn4linkMaxXgmiSpeed token.", "type": "string", "enum": [ "platform-default", "20Gbps", "25Gbps", "32Gbps", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnAcpiSratL3numa": { "description": "BIOS Token for setting ACPI SRAT L3 Cache As NUMA Domain configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDfCmnAcpiSratL3numa token.\n* `disabled` - Value - disabled for configuring CbsDfCmnAcpiSratL3numa token.\n* `enabled` - Value - enabled for configuring CbsDfCmnAcpiSratL3numa token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnDramNps": { "description": "BIOS Token for setting NUMA Nodes per Socket configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDfCmnDramNps token.\n* `NPS0` - Value - NPS0 for configuring CbsDfCmnDramNps token.\n* `NPS1` - Value - NPS1 for configuring CbsDfCmnDramNps token.\n* `NPS2` - Value - NPS2 for configuring CbsDfCmnDramNps token.\n* `NPS4` - Value - NPS4 for configuring CbsDfCmnDramNps token.", "type": "string", "enum": [ "platform-default", "Auto", "NPS0", "NPS1", "NPS2", "NPS4" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnDramScrubTime": { "description": "BIOS Token for setting DRAM Scrub Time configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1 hour` - Value - 1 hour for configuring CbsDfCmnDramScrubTime token.\n* `4 hours` - Value - 4 hours for configuring CbsDfCmnDramScrubTime token.\n* `6 hours` - Value - 6 hours for configuring CbsDfCmnDramScrubTime token.\n* `8 hours` - Value - 8 hours for configuring CbsDfCmnDramScrubTime token.\n* `12 hours` - Value - 12 hours for configuring CbsDfCmnDramScrubTime token.\n* `16 hours` - Value - 16 hours for configuring CbsDfCmnDramScrubTime token.\n* `24 hours` - Value - 24 hours for configuring CbsDfCmnDramScrubTime token.\n* `48 hours` - Value - 48 hours for configuring CbsDfCmnDramScrubTime token.\n* `Auto` - Value - Auto for configuring CbsDfCmnDramScrubTime token.\n* `Disabled` - Value - Disabled for configuring CbsDfCmnDramScrubTime token.", "type": "string", "enum": [ "platform-default", "1 hour", "4 hours", "6 hours", "8 hours", "12 hours", "16 hours", "24 hours", "48 hours", "Auto", "Disabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnMemIntlv": { "description": "BIOS Token for setting AMD Memory Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDfCmnMemIntlv token.\n* `Channel` - Value - Channel for configuring CbsDfCmnMemIntlv token.\n* `Die` - Value - Die for configuring CbsDfCmnMemIntlv token.\n* `None` - Value - None for configuring CbsDfCmnMemIntlv token.\n* `Socket` - Value - Socket for configuring CbsDfCmnMemIntlv token.", "type": "string", "enum": [ "platform-default", "Auto", "Channel", "Die", "None", "Socket" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnMemIntlvControl": { "description": "BIOS Token for setting Memory Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsDfCmnMemIntlvControl token.\n* `disabled` - Value - disabled for configuring CbsDfCmnMemIntlvControl token.\n* `enabled` - Value - enabled for configuring CbsDfCmnMemIntlvControl token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsDfCmnMemIntlvSize": { "description": "BIOS Token for setting AMD Memory Interleaving Size configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `256 Bytes` - Value - 256 Bytes for configuring CbsDfCmnMemIntlvSize token.\n* `512 Bytes` - Value - 512 Bytes for configuring CbsDfCmnMemIntlvSize token.\n* `1 KB` - Value - 1 KiB for configuring CbsDfCmnMemIntlvSize token.\n* `2 KB` - Value - 2 KiB for configuring CbsDfCmnMemIntlvSize token.\n* `4 KB` - Value - 4 KiB for configuring CbsDfCmnMemIntlvSize token.\n* `Auto` - Value - Auto for configuring CbsDfCmnMemIntlvSize token.", "type": "string", "enum": [ "platform-default", "256 Bytes", "512 Bytes", "1 KB", "2 KB", "4 KB", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsDfDbgXgmiLinkCfg": { "description": "BIOS Token for setting xGMI Link Configuration configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `2 xGMI Links` - Value - 2 xGMI Links for configuring CbsDfDbgXgmiLinkCfg token.\n* `3 xGMI Links` - Value - 3 xGMI Links for configuring CbsDfDbgXgmiLinkCfg token.\n* `4 xGMI Links` - Value - 4 xGMI Links for configuring CbsDfDbgXgmiLinkCfg token.\n* `Auto` - Value - Auto for configuring CbsDfDbgXgmiLinkCfg token.", "type": "string", "enum": [ "platform-default", "2 xGMI Links", "3 xGMI Links", "4 xGMI Links", "Auto" ], "default": "platform-default", "x-omitempty": true }, "CbsGnbDbgPcieTbtSupport": { "description": "BIOS Token for setting PCIe Ten Bit Tag Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsGnbDbgPcieTbtSupport token.\n* `disabled` - Value - disabled for configuring CbsGnbDbgPcieTbtSupport token.\n* `enabled` - Value - enabled for configuring CbsGnbDbgPcieTbtSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CbsSevSnpSupport": { "description": "BIOS Token for setting SEV-SNP Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CbsSevSnpSupport token.\n* `disabled` - Value - disabled for configuring CbsSevSnpSupport token.\n* `enabled` - Value - enabled for configuring CbsSevSnpSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "CdnEnable": { "description": "BIOS Token for setting Consistent Device Naming configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CdnSupport": { "description": "BIOS Token for setting CDN Support for LOM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring CdnSupport token.\n* `enabled` - Value - enabled for configuring CdnSupport token.\n* `LOMs Only` - Value - LOMs Only for configuring CdnSupport token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "LOMs Only" ], "default": "platform-default", "x-omitempty": true }, "ChannelInterLeave": { "description": "BIOS Token for setting Channel Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1-way` - Value - 1-way for configuring ChannelInterLeave token.\n* `2-way` - Value - 2-way for configuring ChannelInterLeave token.\n* `3-way` - Value - 3-way for configuring ChannelInterLeave token.\n* `4-way` - Value - 4-way for configuring ChannelInterLeave token.\n* `auto` - Value - auto for configuring ChannelInterLeave token.", "type": "string", "enum": [ "platform-default", "1-way", "2-way", "3-way", "4-way", "auto" ], "default": "platform-default", "x-omitempty": true }, "CiscoAdaptiveMemTraining": { "description": "BIOS Token for setting Adaptive Memory Training configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CiscoDebugLevel": { "description": "BIOS Token for setting BIOS Techlog Level configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Maximum` - Value - Maximum for configuring CiscoDebugLevel token.\n* `Minimum` - Value - Minimum for configuring CiscoDebugLevel token.\n* `Normal` - Value - Normal for configuring CiscoDebugLevel token.", "type": "string", "enum": [ "platform-default", "Maximum", "Minimum", "Normal" ], "default": "platform-default", "x-omitempty": true }, "CiscoOpromLaunchOptimization": { "description": "BIOS Token for setting OptionROM Launch Optimization configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CiscoXgmiMaxSpeed": { "description": "BIOS Token for setting Cisco xGMI Max Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CkeLowPolicy": { "description": "BIOS Token for setting CKE Low Policy configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `auto` - Value - auto for configuring CkeLowPolicy token.\n* `disabled` - Value - disabled for configuring CkeLowPolicy token.\n* `fast` - Value - fast for configuring CkeLowPolicy token.\n* `slow` - Value - slow for configuring CkeLowPolicy token.", "type": "string", "enum": [ "platform-default", "auto", "disabled", "fast", "slow" ], "default": "platform-default", "x-omitempty": true }, "ClosedLoopThermThrotl": { "description": "BIOS Token for setting Closed Loop Thermal Throttling configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CmciEnable": { "description": "BIOS Token for setting Processor CMCI configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "ConfigTdp": { "description": "BIOS Token for setting Config TDP configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "ConfigTdpLevel": { "description": "BIOS Token for setting Configurable TDP Level configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Level 1` - Value - Level 1 for configuring ConfigTdpLevel token.\n* `Level 2` - Value - Level 2 for configuring ConfigTdpLevel token.\n* `Normal` - Value - Normal for configuring ConfigTdpLevel token.", "type": "string", "enum": [ "platform-default", "Level 1", "Level 2", "Normal" ], "default": "platform-default", "x-omitempty": true }, "ConsoleRedirection": { "description": "BIOS Token for setting Console Redirection configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `com-0` - Value - com-0 for configuring ConsoleRedirection token.\n* `com-1` - Value - com-1 for configuring ConsoleRedirection token.\n* `disabled` - Value - disabled for configuring ConsoleRedirection token.\n* `enabled` - Value - enabled for configuring ConsoleRedirection token.\n* `serial-port-a` - Value - serial-port-a for configuring ConsoleRedirection token.", "type": "string", "enum": [ "platform-default", "com-0", "com-1", "disabled", "enabled", "serial-port-a" ], "default": "platform-default", "x-omitempty": true }, "CoreMultiProcessing": { "description": "BIOS Token for setting Core Multi Processing configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1` - Value - 1 for configuring CoreMultiProcessing token.\n* `2` - Value - 2 for configuring CoreMultiProcessing token.\n* `3` - Value - 3 for configuring CoreMultiProcessing token.\n* `4` - Value - 4 for configuring CoreMultiProcessing token.\n* `5` - Value - 5 for configuring CoreMultiProcessing token.\n* `6` - Value - 6 for configuring CoreMultiProcessing token.\n* `7` - Value - 7 for configuring CoreMultiProcessing token.\n* `8` - Value - 8 for configuring CoreMultiProcessing token.\n* `9` - Value - 9 for configuring CoreMultiProcessing token.\n* `10` - Value - 10 for configuring CoreMultiProcessing token.\n* `11` - Value - 11 for configuring CoreMultiProcessing token.\n* `12` - Value - 12 for configuring CoreMultiProcessing token.\n* `13` - Value - 13 for configuring CoreMultiProcessing token.\n* `14` - Value - 14 for configuring CoreMultiProcessing token.\n* `15` - Value - 15 for configuring CoreMultiProcessing token.\n* `16` - Value - 16 for configuring CoreMultiProcessing token.\n* `17` - Value - 17 for configuring CoreMultiProcessing token.\n* `18` - Value - 18 for configuring CoreMultiProcessing token.\n* `19` - Value - 19 for configuring CoreMultiProcessing token.\n* `20` - Value - 20 for configuring CoreMultiProcessing token.\n* `21` - Value - 21 for configuring CoreMultiProcessing token.\n* `22` - Value - 22 for configuring CoreMultiProcessing token.\n* `23` - Value - 23 for configuring CoreMultiProcessing token.\n* `24` - Value - 24 for configuring CoreMultiProcessing token.\n* `25` - Value - 25 for configuring CoreMultiProcessing token.\n* `26` - Value - 26 for configuring CoreMultiProcessing token.\n* `27` - Value - 27 for configuring CoreMultiProcessing token.\n* `28` - Value - 28 for configuring CoreMultiProcessing token.\n* `29` - Value - 29 for configuring CoreMultiProcessing token.\n* `30` - Value - 30 for configuring CoreMultiProcessing token.\n* `31` - Value - 31 for configuring CoreMultiProcessing token.\n* `32` - Value - 32 for configuring CoreMultiProcessing token.\n* `33` - Value - 33 for configuring CoreMultiProcessing token.\n* `34` - Value - 34 for configuring CoreMultiProcessing token.\n* `35` - Value - 35 for configuring CoreMultiProcessing token.\n* `36` - Value - 36 for configuring CoreMultiProcessing token.\n* `37` - Value - 37 for configuring CoreMultiProcessing token.\n* `38` - Value - 38 for configuring CoreMultiProcessing token.\n* `39` - Value - 39 for configuring CoreMultiProcessing token.\n* `40` - Value - 40 for configuring CoreMultiProcessing token.\n* `41` - Value - 41 for configuring CoreMultiProcessing token.\n* `42` - Value - 42 for configuring CoreMultiProcessing token.\n* `43` - Value - 43 for configuring CoreMultiProcessing token.\n* `44` - Value - 44 for configuring CoreMultiProcessing token.\n* `45` - Value - 45 for configuring CoreMultiProcessing token.\n* `46` - Value - 46 for configuring CoreMultiProcessing token.\n* `47` - Value - 47 for configuring CoreMultiProcessing token.\n* `48` - Value - 48 for configuring CoreMultiProcessing token.\n* `49` - Value - 49 for configuring CoreMultiProcessing token.\n* `50` - Value - 50 for configuring CoreMultiProcessing token.\n* `51` - Value - 51 for configuring CoreMultiProcessing token.\n* `52` - Value - 52 for configuring CoreMultiProcessing token.\n* `53` - Value - 53 for configuring CoreMultiProcessing token.\n* `54` - Value - 54 for configuring CoreMultiProcessing token.\n* `55` - Value - 55 for configuring CoreMultiProcessing token.\n* `56` - Value - 56 for configuring CoreMultiProcessing token.\n* `57` - Value - 57 for configuring CoreMultiProcessing token.\n* `58` - Value - 58 for configuring CoreMultiProcessing token.\n* `59` - Value - 59 for configuring CoreMultiProcessing token.\n* `60` - Value - 60 for configuring CoreMultiProcessing token.\n* `61` - Value - 61 for configuring CoreMultiProcessing token.\n* `62` - Value - 62 for configuring CoreMultiProcessing token.\n* `63` - Value - 63 for configuring CoreMultiProcessing token.\n* `64` - Value - 64 for configuring CoreMultiProcessing token.\n* `65` - Value - 65 for configuring CoreMultiProcessing token.\n* `66` - Value - 66 for configuring CoreMultiProcessing token.\n* `67` - Value - 67 for configuring CoreMultiProcessing token.\n* `68` - Value - 68 for configuring CoreMultiProcessing token.\n* `69` - Value - 69 for configuring CoreMultiProcessing token.\n* `70` - Value - 70 for configuring CoreMultiProcessing token.\n* `71` - Value - 71 for configuring CoreMultiProcessing token.\n* `72` - Value - 72 for configuring CoreMultiProcessing token.\n* `73` - Value - 73 for configuring CoreMultiProcessing token.\n* `74` - Value - 74 for configuring CoreMultiProcessing token.\n* `75` - Value - 75 for configuring CoreMultiProcessing token.\n* `76` - Value - 76 for configuring CoreMultiProcessing token.\n* `77` - Value - 77 for configuring CoreMultiProcessing token.\n* `78` - Value - 78 for configuring CoreMultiProcessing token.\n* `79` - Value - 79 for configuring CoreMultiProcessing token.\n* `80` - Value - 80 for configuring CoreMultiProcessing token.\n* `81` - Value - 81 for configuring CoreMultiProcessing token.\n* `82` - Value - 82 for configuring CoreMultiProcessing token.\n* `83` - Value - 83 for configuring CoreMultiProcessing token.\n* `84` - Value - 84 for configuring CoreMultiProcessing token.\n* `85` - Value - 85 for configuring CoreMultiProcessing token.\n* `86` - Value - 86 for configuring CoreMultiProcessing token.\n* `all` - Value - all for configuring CoreMultiProcessing token.", "type": "string", "enum": [ "platform-default", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "39", "40", "41", "42", "43", "44", "45", "46", "47", "48", "49", "50", "51", "52", "53", "54", "55", "56", "57", "58", "59", "60", "61", "62", "63", "64", "65", "66", "67", "68", "69", "70", "71", "72", "73", "74", "75", "76", "77", "78", "79", "80", "81", "82", "83", "84", "85", "86", "all" ], "default": "platform-default", "x-omitempty": true }, "CpuEnergyPerformance": { "description": "BIOS Token for setting Energy Performance configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `balanced-energy` - Value - balanced-energy for configuring CpuEnergyPerformance token.\n* `balanced-performance` - Value - balanced-performance for configuring CpuEnergyPerformance token.\n* `balanced-power` - Value - balanced-power for configuring CpuEnergyPerformance token.\n* `energy-efficient` - Value - energy-efficient for configuring CpuEnergyPerformance token.\n* `performance` - Value - performance for configuring CpuEnergyPerformance token.\n* `power` - Value - power for configuring CpuEnergyPerformance token.", "type": "string", "enum": [ "platform-default", "balanced-energy", "balanced-performance", "balanced-power", "energy-efficient", "performance", "power" ], "default": "platform-default", "x-omitempty": true }, "CpuFrequencyFloor": { "description": "BIOS Token for setting Frequency Floor Override configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CpuPaLimit": { "description": "BIOS Token for setting Limit CPU PA to 46 Bits configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "CpuPerfEnhancement": { "description": "BIOS Token for setting Enhanced CPU Performance configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CpuPerfEnhancement token.\n* `Disabled` - Value - Disabled for configuring CpuPerfEnhancement token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled" ], "default": "platform-default", "x-omitempty": true }, "CpuPerformance": { "description": "BIOS Token for setting CPU Performance configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `custom` - Value - custom for configuring CpuPerformance token.\n* `enterprise` - Value - enterprise for configuring CpuPerformance token.\n* `high-throughput` - Value - high-throughput for configuring CpuPerformance token.\n* `hpc` - Value - hpc for configuring CpuPerformance token.", "type": "string", "enum": [ "platform-default", "custom", "enterprise", "high-throughput", "hpc" ], "default": "platform-default", "x-omitempty": true }, "CpuPowerManagement": { "description": "BIOS Token for setting Power Technology configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `custom` - Value - custom for configuring CpuPowerManagement token.\n* `disabled` - Value - disabled for configuring CpuPowerManagement token.\n* `energy-efficient` - Value - energy-efficient for configuring CpuPowerManagement token.\n* `performance` - Value - performance for configuring CpuPowerManagement token.", "type": "string", "enum": [ "platform-default", "custom", "disabled", "energy-efficient", "performance" ], "default": "platform-default", "x-omitempty": true }, "CrQos": { "description": "BIOS Token for setting CR QoS configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disabled` - Value - Disabled for configuring CrQos token.\n* `Mode 0 - Disable the PMem QoS Feature` - Value - Mode 0 - Disable the PMem QoS Feature for configuring CrQos token.\n* `Mode 1 - M2M QoS Enable and CHA QoS Disable` - Value - Mode 1 - M2M QoS Enable and CHA QoS Disable for configuring CrQos token.\n* `Mode 2 - M2M QoS Enable and CHA QoS Enable` - Value - Mode 2 - M2M QoS Enable and CHA QoS Enable for configuring CrQos token.\n* `Profile 1` - Value - Profile 1 for configuring CrQos token.\n* `Recipe 1` - Value - Recipe 1 for configuring CrQos token.\n* `Recipe 2` - Value - Recipe 2 for configuring CrQos token.\n* `Recipe 3` - Value - Recipe 3 for configuring CrQos token.", "type": "string", "enum": [ "platform-default", "Disabled", "Mode 0 - Disable the PMem QoS Feature", "Mode 1 - M2M QoS Enable and CHA QoS Disable", "Mode 2 - M2M QoS Enable and CHA QoS Enable", "Profile 1", "Recipe 1", "Recipe 2", "Recipe 3" ], "default": "platform-default", "x-omitempty": true }, "CrfastgoConfig": { "description": "BIOS Token for setting CR FastGo Config configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring CrfastgoConfig token.\n* `Default` - Value - Default for configuring CrfastgoConfig token.\n* `Disable optimization` - Value - Disable optimization for configuring CrfastgoConfig token.\n* `Enable optimization` - Value - Enable optimization for configuring CrfastgoConfig token.\n* `Option 1` - Value - Option 1 for configuring CrfastgoConfig token.\n* `Option 2` - Value - Option 2 for configuring CrfastgoConfig token.\n* `Option 3` - Value - Option 3 for configuring CrfastgoConfig token.\n* `Option 4` - Value - Option 4 for configuring CrfastgoConfig token.\n* `Option 5` - Value - Option 5 for configuring CrfastgoConfig token.", "type": "string", "enum": [ "platform-default", "Auto", "Default", "Disable optimization", "Enable optimization", "Option 1", "Option 2", "Option 3", "Option 4", "Option 5" ], "default": "platform-default", "x-omitempty": true }, "DcpmmFirmwareDowngrade": { "description": "BIOS Token for setting DCPMM Firmware Downgrade configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "DemandScrub": { "description": "BIOS Token for setting Demand Scrub configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "DfxOsbEn": { "description": "BIOS Token for setting DFX OSB configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring DfxOsbEn token.\n* `disabled` - Value - disabled for configuring DfxOsbEn token.\n* `enabled` - Value - enabled for configuring DfxOsbEn token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "DirectCacheAccess": { "description": "BIOS Token for setting Direct Cache Access Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `auto` - Value - auto for configuring DirectCacheAccess token.\n* `disabled` - Value - disabled for configuring DirectCacheAccess token.\n* `enabled` - Value - enabled for configuring DirectCacheAccess token.", "type": "string", "enum": [ "platform-default", "auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "DmaCtrlOptIn": { "description": "BIOS Token for setting DMA Control Opt-In Flag configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "DramClockThrottling": { "description": "BIOS Token for setting DRAM Clock Throttling configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring DramClockThrottling token.\n* `Balanced` - Value - Balanced for configuring DramClockThrottling token.\n* `Energy Efficient` - Value - Energy Efficient for configuring DramClockThrottling token.\n* `Performance` - Value - Performance for configuring DramClockThrottling token.", "type": "string", "enum": [ "platform-default", "Auto", "Balanced", "Energy Efficient", "Performance" ], "default": "platform-default", "x-omitempty": true }, "DramRefreshRate": { "description": "BIOS Token for setting DRAM Refresh Rate configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1x` - Value - 1x for configuring DramRefreshRate token.\n* `2x` - Value - 2x for configuring DramRefreshRate token.\n* `3x` - Value - 3x for configuring DramRefreshRate token.\n* `4x` - Value - 4x for configuring DramRefreshRate token.\n* `Auto` - Value - Auto for configuring DramRefreshRate token.", "type": "string", "enum": [ "platform-default", "1x", "2x", "3x", "4x", "Auto" ], "default": "platform-default", "x-omitempty": true }, "DramSwThermalThrottling": { "description": "BIOS Token for setting DRAM SW Thermal Throttling configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EadrSupport": { "description": "BIOS Token for setting eADR Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring EadrSupport token.\n* `disabled` - Value - disabled for configuring EadrSupport token.\n* `enabled` - Value - enabled for configuring EadrSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "EdpcEn": { "description": "BIOS Token for setting IIO eDPC Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disabled` - Value - Disabled for configuring EdpcEn token.\n* `On Fatal Error` - Value - On Fatal Error for configuring EdpcEn token.\n* `On Fatal and Non-Fatal Errors` - Value - On Fatal and Non-Fatal Errors for configuring EdpcEn token.", "type": "string", "enum": [ "platform-default", "Disabled", "On Fatal Error", "On Fatal and Non-Fatal Errors" ], "default": "platform-default", "x-omitempty": true }, "EnableClockSpreadSpec": { "description": "BIOS Token for setting External SSC Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `0P3_Percent` - Value - 0P3_Percent for configuring EnableClockSpreadSpec token.\n* `0P5_Percent` - Value - 0P5_Percent for configuring EnableClockSpreadSpec token.\n* `disabled` - Value - disabled for configuring EnableClockSpreadSpec token.\n* `enabled` - Value - enabled for configuring EnableClockSpreadSpec token.\n* `Hardware` - Value - Hardware for configuring EnableClockSpreadSpec token.\n* `Off` - Value - Off for configuring EnableClockSpreadSpec token.", "type": "string", "enum": [ "platform-default", "0P3_Percent", "0P5_Percent", "disabled", "enabled", "Hardware", "Off" ], "default": "platform-default", "x-omitempty": true }, "EnableMktme": { "description": "BIOS Token for setting Multikey Total Memory Encryption (MK-TME) configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnableRmt": { "description": "BIOS Token for setting Rank Margin Tool configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnableSgx": { "description": "BIOS Token for setting Software Guard Extensions (SGX) configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnableTdx": { "description": "BIOS Token for setting Trust Domain Extension (TDX) configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnableTdxSeamldr": { "description": "BIOS Token for setting TDX Secure Arbitration Mode (SEAM) Loader configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnableTme": { "description": "BIOS Token for setting Total Memory Encryption (TME) configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EnergyEfficientTurbo": { "description": "BIOS Token for setting Energy Efficient Turbo configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EngPerfTuning": { "description": "BIOS Token for setting Energy Performance Tuning configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `BIOS` - Value - BIOS for configuring EngPerfTuning token.\n* `OS` - Value - OS for configuring EngPerfTuning token.", "type": "string", "enum": [ "platform-default", "BIOS", "OS" ], "default": "platform-default", "x-omitempty": true }, "EnhancedIntelSpeedStepTech": { "description": "BIOS Token for setting Enhanced Intel Speedstep (R) Technology configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EpochUpdate": { "description": "BIOS Token for setting Select Owner EPOCH Input Type configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Change to New Random Owner EPOCHs` - Value - Change to New Random Owner EPOCHs for configuring EpochUpdate token.\n* `Manual User Defined Owner EPOCHs` - Value - Manual User Defined Owner EPOCHs for configuring EpochUpdate token.\n* `SGX Owner EPOCH activated` - Value - SGX Owner EPOCH activated for configuring EpochUpdate token.\n* `SGX Owner EPOCH deactivated` - Value - SGX Owner EPOCH deactivated for configuring EpochUpdate token.", "type": "string", "enum": [ "platform-default", "Change to New Random Owner EPOCHs", "Manual User Defined Owner EPOCHs", "SGX Owner EPOCH activated", "SGX Owner EPOCH deactivated" ], "default": "platform-default", "x-omitempty": true }, "EppEnable": { "description": "BIOS Token for setting Processor EPP Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "EppProfile": { "description": "BIOS Token for setting EPP Profile configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Balanced Performance` - Value - Balanced Performance for configuring EppProfile token.\n* `Balanced Power` - Value - Balanced Power for configuring EppProfile token.\n* `Performance` - Value - Performance for configuring EppProfile token.\n* `Power` - Value - Power for configuring EppProfile token.", "type": "string", "enum": [ "platform-default", "Balanced Performance", "Balanced Power", "Performance", "Power" ], "default": "platform-default", "x-omitempty": true }, "ErrorCheckScrub": { "description": "BIOS Token for setting Error Check Scrub configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disabled` - Value - Disabled for configuring ErrorCheckScrub token.\n* `Enabled with Result Collection` - Value - Enabled with Result Collection for configuring ErrorCheckScrub token.\n* `Enabled without Result Collection` - Value - Enabled without Result Collection for configuring ErrorCheckScrub token.", "type": "string", "enum": [ "platform-default", "Disabled", "Enabled with Result Collection", "Enabled without Result Collection" ], "default": "platform-default", "x-omitempty": true }, "ExecuteDisableBit": { "description": "BIOS Token for setting Execute Disable Bit configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "ExtendedApic": { "description": "BIOS Token for setting Local X2 Apic configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring ExtendedApic token.\n* `enabled` - Value - enabled for configuring ExtendedApic token.\n* `X2APIC` - Value - X2APIC for configuring ExtendedApic token.\n* `XAPIC` - Value - XAPIC for configuring ExtendedApic token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "X2APIC", "XAPIC" ], "default": "platform-default", "x-omitempty": true }, "FlowControl": { "description": "BIOS Token for setting Flow Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `none` - Value - none for configuring FlowControl token.\n* `rts-cts` - Value - rts-cts for configuring FlowControl token.", "type": "string", "enum": [ "platform-default", "none", "rts-cts" ], "default": "platform-default", "x-omitempty": true }, "Frb2enable": { "description": "BIOS Token for setting FRB-2 Timer configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "GpuDirectCpu1": { "description": "BIOS Token for setting GPU Direct CPU1 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "GpuDirectCpu2": { "description": "BIOS Token for setting GPU Direct CPU2 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "GpuDirectCpu3": { "description": "BIOS Token for setting GPU Direct CPU3 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "GpuDirectCpu4": { "description": "BIOS Token for setting GPU Direct CPU4 configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "HardwarePrefetch": { "description": "BIOS Token for setting Hardware Prefetcher configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "HwpmEnable": { "description": "BIOS Token for setting CPU Hardware Power Management configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disabled` - Value - Disabled for configuring HwpmEnable token.\n* `HWPM Native Mode` - Value - HWPM Native Mode for configuring HwpmEnable token.\n* `HWPM OOB Mode` - Value - HWPM OOB Mode for configuring HwpmEnable token.\n* `NATIVE MODE` - Value - NATIVE MODE for configuring HwpmEnable token.\n* `Native Mode with no Legacy` - Value - Native Mode with no Legacy for configuring HwpmEnable token.\n* `OOB MODE` - Value - OOB MODE for configuring HwpmEnable token.", "type": "string", "enum": [ "platform-default", "Disabled", "HWPM Native Mode", "HWPM OOB Mode", "NATIVE MODE", "Native Mode with no Legacy", "OOB MODE" ], "default": "platform-default", "x-omitempty": true }, "ImcInterleave": { "description": "BIOS Token for setting IMC Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1-way Interleave` - Value - 1-way Interleave for configuring ImcInterleave token.\n* `2-way Interleave` - Value - 2-way Interleave for configuring ImcInterleave token.\n* `Auto` - Value - Auto for configuring ImcInterleave token.", "type": "string", "enum": [ "platform-default", "1-way Interleave", "2-way Interleave", "Auto" ], "default": "platform-default", "x-omitempty": true }, "IntelDynamicSpeedSelect": { "description": "BIOS Token for setting Intel Dynamic Speed Select configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelHyperThreadingTech": { "description": "BIOS Token for setting Intel HyperThreading Tech configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelSpeedSelect": { "description": "BIOS Token for setting Intel Speed Select configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring IntelSpeedSelect token.\n* `Base` - Value - Base for configuring IntelSpeedSelect token.\n* `Config 1` - Value - Config 1 for configuring IntelSpeedSelect token.\n* `Config 2` - Value - Config 2 for configuring IntelSpeedSelect token.\n* `Config 3` - Value - Config 3 for configuring IntelSpeedSelect token.\n* `Config 4` - Value - Config 4 for configuring IntelSpeedSelect token.\n* `Level 0` - Value - Level 0 for configuring IntelSpeedSelect token.\n* `Level 1` - Value - Level 1 for configuring IntelSpeedSelect token.\n* `Level 2` - Value - Level 2 for configuring IntelSpeedSelect token.\n* `Level 3` - Value - Level 3 for configuring IntelSpeedSelect token.\n* `Level 4` - Value - Level 4 for configuring IntelSpeedSelect token.", "type": "string", "enum": [ "platform-default", "Auto", "Base", "Config 1", "Config 2", "Config 3", "Config 4", "Level 0", "Level 1", "Level 2", "Level 3", "Level 4" ], "default": "platform-default", "x-omitempty": true }, "IntelTurboBoostTech": { "description": "BIOS Token for setting Intel Turbo Boost Tech configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVirtualizationTechnology": { "description": "BIOS Token for setting Intel (R) VT configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVtForDirectedIo": { "description": "BIOS Token for setting Intel VT for Directed IO configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVtdCoherencySupport": { "description": "BIOS Token for setting Intel (R) VT-d Coherency Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVtdInterruptRemapping": { "description": "BIOS Token for setting Intel (R) VT-d Interrupt Remapping configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVtdPassThroughDmaSupport": { "description": "BIOS Token for setting Intel (R) VT-d PassThrough DMA Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IntelVtdatsSupport": { "description": "BIOS Token for setting Intel VTD ATS Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IoatConfigCpm": { "description": "BIOS Token for setting IOAT Configuration configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "IohErrorEnable": { "description": "BIOS Token for setting IIO Error Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `No` - Value - No for configuring IohErrorEnable token.\n* `Yes` - Value - Yes for configuring IohErrorEnable token.", "type": "string", "enum": [ "platform-default", "No", "Yes" ], "default": "platform-default", "x-omitempty": true }, "IohResource": { "description": "BIOS Token for setting IOH Resource Allocation configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `IOH0 24k IOH1 40k` - Value - IOH0 24k IOH1 40k for configuring IohResource token.\n* `IOH0 32k IOH1 32k` - Value - IOH0 32k IOH1 32k for configuring IohResource token.\n* `IOH0 40k IOH1 24k` - Value - IOH0 40k IOH1 24k for configuring IohResource token.\n* `IOH0 48k IOH1 16k` - Value - IOH0 48k IOH1 16k for configuring IohResource token.\n* `IOH0 56k IOH1 8k` - Value - IOH0 56k IOH1 8k for configuring IohResource token.", "type": "string", "enum": [ "platform-default", "IOH0 24k IOH1 40k", "IOH0 32k IOH1 32k", "IOH0 40k IOH1 24k", "IOH0 48k IOH1 16k", "IOH0 56k IOH1 8k" ], "default": "platform-default", "x-omitempty": true }, "IpPrefetch": { "description": "BIOS Token for setting DCU IP Prefetcher configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Ipv4http": { "description": "BIOS Token for setting IPV4 HTTP Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Ipv4pxe": { "description": "BIOS Token for setting IPv4 PXE Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Ipv6http": { "description": "BIOS Token for setting IPV6 HTTP Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Ipv6pxe": { "description": "BIOS Token for setting IPV6 PXE Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "KtiPrefetch": { "description": "BIOS Token for setting KTI Prefetch configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring KtiPrefetch token.\n* `disabled` - Value - disabled for configuring KtiPrefetch token.\n* `enabled` - Value - enabled for configuring KtiPrefetch token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "LatencyOptimizedMode": { "description": "BIOS Token for setting Latency Optimized Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "LegacyOsRedirection": { "description": "BIOS Token for setting Legacy OS Redirection configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "LegacyUsbSupport": { "description": "BIOS Token for setting Legacy USB Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `auto` - Value - auto for configuring LegacyUsbSupport token.\n* `disabled` - Value - disabled for configuring LegacyUsbSupport token.\n* `enabled` - Value - enabled for configuring LegacyUsbSupport token.", "type": "string", "enum": [ "platform-default", "auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "LlcAlloc": { "description": "BIOS Token for setting LLC Dead Line configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring LlcAlloc token.\n* `disabled` - Value - disabled for configuring LlcAlloc token.\n* `enabled` - Value - enabled for configuring LlcAlloc token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "LlcPrefetch": { "description": "BIOS Token for setting LLC Prefetch configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "LomPort0state": { "description": "BIOS Token for setting LOM Port 0 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring LomPort0state token.\n* `enabled` - Value - enabled for configuring LomPort0state token.\n* `Legacy Only` - Value - Legacy Only for configuring LomPort0state token.\n* `UEFI Only` - Value - UEFI Only for configuring LomPort0state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "LomPort1state": { "description": "BIOS Token for setting LOM Port 1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring LomPort1state token.\n* `enabled` - Value - enabled for configuring LomPort1state token.\n* `Legacy Only` - Value - Legacy Only for configuring LomPort1state token.\n* `UEFI Only` - Value - UEFI Only for configuring LomPort1state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "LomPort2state": { "description": "BIOS Token for setting LOM Port 2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring LomPort2state token.\n* `enabled` - Value - enabled for configuring LomPort2state token.\n* `Legacy Only` - Value - Legacy Only for configuring LomPort2state token.\n* `UEFI Only` - Value - UEFI Only for configuring LomPort2state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "LomPort3state": { "description": "BIOS Token for setting LOM Port 3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring LomPort3state token.\n* `enabled` - Value - enabled for configuring LomPort3state token.\n* `Legacy Only` - Value - Legacy Only for configuring LomPort3state token.\n* `UEFI Only` - Value - UEFI Only for configuring LomPort3state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "LomPortsAllState": { "description": "BIOS Token for setting All Onboard LOM Ports configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "LvDdrMode": { "description": "BIOS Token for setting Low Voltage DDR Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `auto` - Value - auto for configuring LvDdrMode token.\n* `performance-mode` - Value - performance-mode for configuring LvDdrMode token.\n* `power-saving-mode` - Value - power-saving-mode for configuring LvDdrMode token.", "type": "string", "enum": [ "platform-default", "auto", "performance-mode", "power-saving-mode" ], "default": "platform-default", "x-omitempty": true }, "MakeDeviceNonBootable": { "description": "BIOS Token for setting Make Device Non Bootable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "MemoryBandwidthBoost": { "description": "BIOS Token for setting Memory Bandwidth Boost configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "MemoryInterLeave": { "description": "BIOS Token for setting Intel Memory Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1 Way Node Interleave` - Value - 1 Way Node Interleave for configuring MemoryInterLeave token.\n* `2 Way Node Interleave` - Value - 2 Way Node Interleave for configuring MemoryInterLeave token.\n* `4 Way Node Interleave` - Value - 4 Way Node Interleave for configuring MemoryInterLeave token.\n* `8 Way Node Interleave` - Value - 8 Way Node Interleave for configuring MemoryInterLeave token.\n* `disabled` - Value - disabled for configuring MemoryInterLeave token.\n* `enabled` - Value - enabled for configuring MemoryInterLeave token.", "type": "string", "enum": [ "platform-default", "1 Way Node Interleave", "2 Way Node Interleave", "4 Way Node Interleave", "8 Way Node Interleave", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "MemoryMappedIoAbove4gb": { "description": "BIOS Token for setting Memory Mapped IO above 4GiB configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "MemoryRefreshRate": { "description": "BIOS Token for setting Memory Refresh Rate configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1x Refresh` - Value - 1x Refresh for configuring MemoryRefreshRate token.\n* `2x Refresh` - Value - 2x Refresh for configuring MemoryRefreshRate token.", "type": "string", "enum": [ "platform-default", "1x Refresh", "2x Refresh" ], "default": "platform-default", "x-omitempty": true }, "MemorySizeLimit": { "description": "BIOS Token for setting Memory Size Limit in GiB configuration (0 - 65535 GiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5])$|^(platform-default)$", "x-omitempty": true }, "MemoryThermalThrottling": { "description": "BIOS Token for setting Memory Thermal Throttling Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `CLTT with PECI` - Value - CLTT with PECI for configuring MemoryThermalThrottling token.\n* `Disabled` - Value - Disabled for configuring MemoryThermalThrottling token.", "type": "string", "enum": [ "platform-default", "CLTT with PECI", "Disabled" ], "default": "platform-default", "x-omitempty": true }, "MirroringMode": { "description": "BIOS Token for setting Mirroring Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `inter-socket` - Value - inter-socket for configuring MirroringMode token.\n* `intra-socket` - Value - intra-socket for configuring MirroringMode token.", "type": "string", "enum": [ "platform-default", "inter-socket", "intra-socket" ], "default": "platform-default", "x-omitempty": true }, "MmcfgBase": { "description": "BIOS Token for setting MMCFG BASE configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1 GB` - Value - 1 GiB for configuring MmcfgBase token.\n* `2 GB` - Value - 2 GiB for configuring MmcfgBase token.\n* `2.5 GB` - Value - 2.5 GiB for configuring MmcfgBase token.\n* `3 GB` - Value - 3 GiB for configuring MmcfgBase token.\n* `Auto` - Value - Auto for configuring MmcfgBase token.", "type": "string", "enum": [ "platform-default", "1 GB", "2 GB", "2.5 GB", "3 GB", "Auto" ], "default": "platform-default", "x-omitempty": true }, "MmiohBase": { "description": "BIOS Token for setting MMIO High Base configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `512G` - Value - 512G for configuring MmiohBase token.\n* `1T` - Value - 1T for configuring MmiohBase token.\n* `2T` - Value - 2T for configuring MmiohBase token.\n* `4T` - Value - 4T for configuring MmiohBase token.\n* `16T` - Value - 16T for configuring MmiohBase token.\n* `24T` - Value - 24T for configuring MmiohBase token.\n* `30T` - Value - 30T for configuring MmiohBase token.\n* `32T` - Value - 32T for configuring MmiohBase token.\n* `40T` - Value - 40T for configuring MmiohBase token.\n* `56T` - Value - 56T for configuring MmiohBase token.\n* `60T` - Value - 60T for configuring MmiohBase token.\n* `Auto` - Value - Auto for configuring MmiohBase token.", "type": "string", "enum": [ "platform-default", "512G", "1T", "2T", "4T", "16T", "24T", "30T", "32T", "40T", "56T", "60T", "Auto" ], "default": "platform-default", "x-omitempty": true }, "MmiohSize": { "description": "BIOS Token for setting MMIO High Granularity Size configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1G` - Value - 1G for configuring MmiohSize token.\n* `4G` - Value - 4G for configuring MmiohSize token.\n* `16G` - Value - 16G for configuring MmiohSize token.\n* `32G` - Value - 32G for configuring MmiohSize token.\n* `64G` - Value - 64G for configuring MmiohSize token.\n* `256G` - Value - 256G for configuring MmiohSize token.\n* `1024G` - Value - 1024G for configuring MmiohSize token.\n* `Auto` - Value - Auto for configuring MmiohSize token.", "type": "string", "enum": [ "platform-default", "1G", "4G", "16G", "32G", "64G", "256G", "1024G", "Auto" ], "default": "platform-default", "x-omitempty": true }, "Model": { "description": "Specifies supported server model.\n* `Not-Applicable` - Represents case where the server model does not apply.\n* `UCSC845A` - Represents UCS C845A server model.", "type": "string", "enum": [ "Not-Applicable", "UCSC845A" ], "default": "Not-Applicable", "x-createOnly": true, "x-omitempty": true }, "NetworkStack": { "description": "BIOS Token for setting Network Stack configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "NumaOptimized": { "description": "BIOS Token for setting NUMA Optimized configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "NvmdimmPerformConfig": { "description": "BIOS Token for setting NVM Performance Setting configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `BW Optimized` - Value - BW Optimized for configuring NvmdimmPerformConfig token.\n* `Balanced Profile` - Value - Balanced Profile for configuring NvmdimmPerformConfig token.\n* `Latency Optimized` - Value - Latency Optimized for configuring NvmdimmPerformConfig token.", "type": "string", "enum": [ "platform-default", "BW Optimized", "Balanced Profile", "Latency Optimized" ], "default": "platform-default", "x-omitempty": true }, "Onboard10gbitLom": { "description": "BIOS Token for setting Onboard 10Gbit LOM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "OnboardGbitLom": { "description": "BIOS Token for setting Onboard Gbit LOM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "OnboardScuStorageSupport": { "description": "BIOS Token for setting Onboard SCU Storage Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "OnboardScuStorageSwStack": { "description": "BIOS Token for setting Onboard SCU Storage SW Stack configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Intel RSTe` - Value - Intel RSTe for configuring OnboardScuStorageSwStack token.\n* `LSI SW RAID` - Value - LSI SW RAID for configuring OnboardScuStorageSwStack token.", "type": "string", "enum": [ "platform-default", "Intel RSTe", "LSI SW RAID" ], "default": "platform-default", "x-omitempty": true }, "OperationMode": { "description": "BIOS Token for setting Operation Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Test Only` - Value - Test Only for configuring OperationMode token.\n* `Test and Repair` - Value - Test and Repair for configuring OperationMode token.", "type": "string", "enum": [ "platform-default", "Test Only", "Test and Repair" ], "default": "platform-default", "x-omitempty": true }, "OptimizedPowerMode": { "description": "BIOS Token for setting Optimized Power Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "OsBootWatchdogTimer": { "description": "BIOS Token for setting OS Boot Watchdog Timer configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "OsBootWatchdogTimerPolicy": { "description": "BIOS Token for setting OS Boot Watchdog Timer Policy configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `do-nothing` - Value - do-nothing for configuring OsBootWatchdogTimerPolicy token.\n* `power-off` - Value - power-off for configuring OsBootWatchdogTimerPolicy token.\n* `reset` - Value - reset for configuring OsBootWatchdogTimerPolicy token.", "type": "string", "enum": [ "platform-default", "do-nothing", "power-off", "reset" ], "default": "platform-default", "x-omitempty": true }, "OsBootWatchdogTimerTimeout": { "description": "BIOS Token for setting OS Boot Watchdog Timer Timeout configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `5-minutes` - Value - 5-minutes for configuring OsBootWatchdogTimerTimeout token.\n* `10-minutes` - Value - 10-minutes for configuring OsBootWatchdogTimerTimeout token.\n* `15-minutes` - Value - 15-minutes for configuring OsBootWatchdogTimerTimeout token.\n* `20-minutes` - Value - 20-minutes for configuring OsBootWatchdogTimerTimeout token.", "type": "string", "enum": [ "platform-default", "5-minutes", "10-minutes", "15-minutes", "20-minutes" ], "default": "platform-default", "x-omitempty": true }, "OutOfBandMgmtPort": { "description": "BIOS Token for setting Out-of-Band Mgmt Port configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PackageCstateLimit": { "description": "BIOS Token for setting Package C State Limit configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PackageCstateLimit token.\n* `C0 C1 State` - Value - C0 C1 State for configuring PackageCstateLimit token.\n* `C0/C1` - Value - C0/C1 for configuring PackageCstateLimit token.\n* `C2` - Value - C2 for configuring PackageCstateLimit token.\n* `C6 Non Retention` - Value - C6 Non Retention for configuring PackageCstateLimit token.\n* `C6 Retention` - Value - C6 Retention for configuring PackageCstateLimit token.\n* `No Limit` - Value - No Limit for configuring PackageCstateLimit token.", "type": "string", "enum": [ "platform-default", "Auto", "C0 C1 State", "C0/C1", "C2", "C6 Non Retention", "C6 Retention", "No Limit" ], "default": "platform-default", "x-omitempty": true }, "PanicHighWatermark": { "description": "BIOS Token for setting Panic and High Watermark configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `High` - Value - High for configuring PanicHighWatermark token.\n* `Low` - Value - Low for configuring PanicHighWatermark token.", "type": "string", "enum": [ "platform-default", "High", "Low" ], "default": "platform-default", "x-omitempty": true }, "PartialCacheLineSparing": { "description": "BIOS Token for setting Partial Cache Line Sparing configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PartialMirrorModeConfig": { "description": "BIOS Token for setting Partial Memory Mirror Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring PartialMirrorModeConfig token.\n* `Percentage` - Value - Percentage for configuring PartialMirrorModeConfig token.\n* `Value in GB` - Value - Value in GiB for configuring PartialMirrorModeConfig token.", "type": "string", "enum": [ "platform-default", "disabled", "Percentage", "Value in GB" ], "default": "platform-default", "x-omitempty": true }, "PartialMirrorPercent": { "description": "BIOS Token for setting Partial Mirror Percentage configuration (0.00 - 50.00 Percentage).", "type": "string", "default": "platform-default", "pattern": "^(\\d\\.\\d{1,2}|[1-4]\\d\\.\\d{1,2}|50\\.[0]{1,2})$|^(platform-default)$", "x-omitempty": true }, "PartialMirrorValue1": { "description": "BIOS Token for setting Partial Mirror1 Size in GiB configuration (0 - 65535 GiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5])$|^(platform-default)$", "x-omitempty": true }, "PartialMirrorValue2": { "description": "BIOS Token for setting Partial Mirror2 Size in GiB configuration (0 - 65535 GiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5])$|^(platform-default)$", "x-omitempty": true }, "PartialMirrorValue3": { "description": "BIOS Token for setting Partial Mirror3 Size in GiB configuration (0 - 65535 GiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5])$|^(platform-default)$", "x-omitempty": true }, "PartialMirrorValue4": { "description": "BIOS Token for setting Partial Mirror4 Size in GiB configuration (0 - 65535 GiB).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5])$|^(platform-default)$", "x-omitempty": true }, "PatrolScrub": { "description": "BIOS Token for setting Patrol Scrub configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring PatrolScrub token.\n* `Enable at End of POST` - Value - Enable at End of POST for configuring PatrolScrub token.\n* `enabled` - Value - enabled for configuring PatrolScrub token.", "type": "string", "enum": [ "platform-default", "disabled", "Enable at End of POST", "enabled" ], "default": "platform-default", "x-omitempty": true }, "PatrolScrubDuration": { "description": "BIOS Token for setting Patrol Scrub Interval configuration (5 - 23 Hour).", "type": "string", "default": "platform-default", "pattern": "^([5-9]|1\\d|2[0-3])$|^(platform-default)$", "x-omitempty": true }, "PcIeRasSupport": { "description": "BIOS Token for setting PCIe RAS Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcIeSsdHotPlugSupport": { "description": "BIOS Token for setting NVMe SSD Hot-Plug Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PchPciePllSsc": { "description": "BIOS Token for setting PCIe PLL SSC Percent configuration (0 - 255 (n/10)%).", "type": "string", "default": "platform-default", "pattern": "^(\\d|[1-9]\\d|1\\d{2}|2[0-4]\\d|25[0-5])$|^(platform-default)$", "x-omitempty": true }, "PchUsb30mode": { "description": "BIOS Token for setting xHCI Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PciOptionRoMs": { "description": "BIOS Token for setting All PCIe Slots OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring PciOptionRoMs token.\n* `enabled` - Value - enabled for configuring PciOptionRoMs token.\n* `Legacy Only` - Value - Legacy Only for configuring PciOptionRoMs token.\n* `UEFI Only` - Value - UEFI Only for configuring PciOptionRoMs token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "PciRomClp": { "description": "BIOS Token for setting PCI ROM CLP configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieAriSupport": { "description": "BIOS Token for setting PCIe ARI Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieAriSupport token.\n* `disabled` - Value - disabled for configuring PcieAriSupport token.\n* `enabled` - Value - enabled for configuring PcieAriSupport token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "PciePllSsc": { "description": "BIOS Token for setting PCIe PLL SSC configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PciePllSsc token.\n* `Disabled` - Value - Disabled for configuring PciePllSsc token.\n* `ZeroPointFive` - Value - ZeroPointFive for configuring PciePllSsc token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "ZeroPointFive" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMraid1linkSpeed": { "description": "BIOS Token for setting MRAID1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotMraid1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotMraid1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotMraid1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotMraid1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotMraid1linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring PcieSlotMraid1linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring PcieSlotMraid1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMraid1optionRom": { "description": "BIOS Token for setting MRAID1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMraid2linkSpeed": { "description": "BIOS Token for setting MRAID2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotMraid2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotMraid2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotMraid2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotMraid2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotMraid2linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring PcieSlotMraid2linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring PcieSlotMraid2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMraid2optionRom": { "description": "BIOS Token for setting MRAID2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMstorraidLinkSpeed": { "description": "BIOS Token for setting PCIe Slot MSTOR Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotMstorraidLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotMstorraidLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotMstorraidLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotMstorraidLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotMstorraidLinkSpeed token.\n* `GEN4` - Value - GEN4 for configuring PcieSlotMstorraidLinkSpeed token.\n* `GEN5` - Value - GEN5 for configuring PcieSlotMstorraidLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotMstorraidOptionRom": { "description": "BIOS Token for setting PCIe Slot MSTOR RAID OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme1linkSpeed": { "description": "BIOS Token for setting NVME 1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme1optionRom": { "description": "BIOS Token for setting NVME 1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme2linkSpeed": { "description": "BIOS Token for setting NVME 2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme2optionRom": { "description": "BIOS Token for setting NVME 2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme3linkSpeed": { "description": "BIOS Token for setting NVME 3 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme3linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme3linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme3linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme3linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme3linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme3optionRom": { "description": "BIOS Token for setting NVME 3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme4linkSpeed": { "description": "BIOS Token for setting NVME 4 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme4linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme4linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme4linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme4linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme4linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme4optionRom": { "description": "BIOS Token for setting NVME 4 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme5linkSpeed": { "description": "BIOS Token for setting NVME 5 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme5linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme5linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme5linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme5linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme5linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme5optionRom": { "description": "BIOS Token for setting NVME 5 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme6linkSpeed": { "description": "BIOS Token for setting NVME 6 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring PcieSlotNvme6linkSpeed token.\n* `Disabled` - Value - Disabled for configuring PcieSlotNvme6linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring PcieSlotNvme6linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring PcieSlotNvme6linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring PcieSlotNvme6linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotNvme6optionRom": { "description": "BIOS Token for setting NVME 6 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PcieSlotsCdnEnable": { "description": "BIOS Token for setting PCIe Slots CDN Control configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PolicyType": { "description": "Specifies BIOS policy compatibility type.\n* `Generic` - Generic BIOS type is compatible only for UCS B, C, and X Series models. Do not attempt to proceed if you are using an unsupported model, as this may result in configuration errors.\n* `ModelSpecific` - Model Specific BIOS type is compatible only for UCS C845A model. Do not attempt to proceed if you are using an unsupported model, as this may result in configuration errors.", "type": "string", "enum": [ "Generic", "ModelSpecific" ], "default": "Generic", "x-createOnly": true, "x-omitempty": true }, "PopSupport": { "description": "BIOS Token for setting Power ON Password configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PostErrorPause": { "description": "BIOS Token for setting POST Error Pause configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PostPackageRepair": { "description": "BIOS Token for setting Post Package Repair configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disabled` - Value - Disabled for configuring PostPackageRepair token.\n* `Hard PPR` - Value - Hard PPR for configuring PostPackageRepair token.", "type": "string", "enum": [ "platform-default", "Disabled", "Hard PPR" ], "default": "platform-default", "x-omitempty": true }, "PreBootDmaProtection": { "description": "BIOS Token for setting PreBoot DMA Protection configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "PrmrrSize": { "description": "BIOS Token for setting PRMRR Size configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1G` - Value - 1G for configuring PrmrrSize token.\n* `2G` - Value - 2G for configuring PrmrrSize token.\n* `4G` - Value - 4G for configuring PrmrrSize token.\n* `8G` - Value - 8G for configuring PrmrrSize token.\n* `16G` - Value - 16G for configuring PrmrrSize token.\n* `32G` - Value - 32G for configuring PrmrrSize token.\n* `64G` - Value - 64G for configuring PrmrrSize token.\n* `128G` - Value - 128G for configuring PrmrrSize token.\n* `256G` - Value - 256G for configuring PrmrrSize token.\n* `512G` - Value - 512G for configuring PrmrrSize token.\n* `128M` - Value - 128M for configuring PrmrrSize token.\n* `256M` - Value - 256M for configuring PrmrrSize token.\n* `512M` - Value - 512M for configuring PrmrrSize token.\n* `Auto` - Value - Auto for configuring PrmrrSize token.\n* `Invalid Config.` - Value - Invalid Config for configuring PrmrrSize token.", "type": "string", "enum": [ "platform-default", "1G", "2G", "4G", "8G", "16G", "32G", "64G", "128G", "256G", "512G", "128M", "256M", "512M", "Auto", "Invalid Config." ], "default": "platform-default", "x-omitempty": true }, "ProcessorC1e": { "description": "BIOS Token for setting Processor C1E configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "ProcessorC3report": { "description": "BIOS Token for setting Processor C3 Report configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "ProcessorC6report": { "description": "BIOS Token for setting Processor C6 Report configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring ProcessorC6report token.\n* `disabled` - Value - disabled for configuring ProcessorC6report token.\n* `enabled` - Value - enabled for configuring ProcessorC6report token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "ProcessorCstate": { "description": "BIOS Token for setting CPU C State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Psata": { "description": "BIOS Token for setting P-SATA Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `AHCI` - Value - AHCI for configuring Psata token.\n* `Disabled` - Value - Disabled for configuring Psata token.\n* `LSI SW RAID` - Value - LSI SW RAID for configuring Psata token.", "type": "string", "enum": [ "platform-default", "AHCI", "Disabled", "LSI SW RAID" ], "default": "platform-default", "x-omitempty": true }, "PstateCoordType": { "description": "BIOS Token for setting P-STATE Coordination configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `HW ALL` - Value - HW ALL for configuring PstateCoordType token.\n* `SW ALL` - Value - SW ALL for configuring PstateCoordType token.\n* `SW ANY` - Value - SW ANY for configuring PstateCoordType token.", "type": "string", "enum": [ "platform-default", "HW ALL", "SW ALL", "SW ANY" ], "default": "platform-default", "x-omitempty": true }, "PuttyKeyPad": { "description": "BIOS Token for setting Putty KeyPad configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `ESCN` - Value - ESCN for configuring PuttyKeyPad token.\n* `LINUX` - Value - LINUX for configuring PuttyKeyPad token.\n* `SCO` - Value - SCO for configuring PuttyKeyPad token.\n* `VT100` - Value - VT100 for configuring PuttyKeyPad token.\n* `VT400` - Value - VT400 for configuring PuttyKeyPad token.\n* `XTERMR6` - Value - XTERMR6 for configuring PuttyKeyPad token.", "type": "string", "enum": [ "platform-default", "ESCN", "LINUX", "SCO", "VT100", "VT400", "XTERMR6" ], "default": "platform-default", "x-omitempty": true }, "PwrPerfTuning": { "description": "BIOS Token for setting Power Performance Tuning configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `bios` - Value - BIOS for configuring PwrPerfTuning token.\n* `os` - Value - os for configuring PwrPerfTuning token.\n* `peci` - Value - peci for configuring PwrPerfTuning token.", "type": "string", "enum": [ "platform-default", "bios", "os", "peci" ], "default": "platform-default", "x-omitempty": true }, "QpiLinkFrequency": { "description": "BIOS Token for setting QPI Link Frequency Select configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `6.4-gt/s` - Value - 6.4-gt/s for configuring QpiLinkFrequency token.\n* `7.2-gt/s` - Value - 7.2-gt/s for configuring QpiLinkFrequency token.\n* `8.0-gt/s` - Value - 8.0-gt/s for configuring QpiLinkFrequency token.\n* `9.6-gt/s` - Value - 9.6-gt/s for configuring QpiLinkFrequency token.\n* `auto` - Value - auto for configuring QpiLinkFrequency token.", "type": "string", "enum": [ "platform-default", "6.4-gt/s", "7.2-gt/s", "8.0-gt/s", "9.6-gt/s", "auto" ], "default": "platform-default", "x-omitempty": true }, "QpiLinkSpeed": { "description": "BIOS Token for setting UPI Link Frequency Select configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `9.6GT/s` - Value - 9.6GT/s for configuring QpiLinkSpeed token.\n* `10.4GT/s` - Value - 10.4GT/s for configuring QpiLinkSpeed token.\n* `11.2GT/s` - Value - 11.2GT/s for configuring QpiLinkSpeed token.\n* `12.8GT/s` - Value - 12.8GT/s for configuring QpiLinkSpeed token.\n* `14.4GT/s` - Value - 14.4GT/s for configuring QpiLinkSpeed token.\n* `16.0GT/s` - Value - 16.0GT/s for configuring QpiLinkSpeed token.\n* `20.0GT/s` - Value - 20.0GT/s for configuring QpiLinkSpeed token.\n* `24.0GT/s` - Value - 24.0GT/s for configuring QpiLinkSpeed token.\n* `Auto` - Value - Auto for configuring QpiLinkSpeed token.\n* `Use Per Link Setting` - Value - Use Per Link Setting for configuring QpiLinkSpeed token.", "type": "string", "enum": [ "platform-default", "9.6GT/s", "10.4GT/s", "11.2GT/s", "12.8GT/s", "14.4GT/s", "16.0GT/s", "20.0GT/s", "24.0GT/s", "Auto", "Use Per Link Setting" ], "default": "platform-default", "x-omitempty": true }, "QpiSnoopMode": { "description": "BIOS Token for setting QPI Snoop Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `auto` - Value - auto for configuring QpiSnoopMode token.\n* `cluster-on-die` - Value - cluster-on-die for configuring QpiSnoopMode token.\n* `early-snoop` - Value - early-snoop for configuring QpiSnoopMode token.\n* `home-directory-snoop` - Value - home-directory-snoop for configuring QpiSnoopMode token.\n* `home-directory-snoop-with-osb` - Value - home-directory-snoop-with-osb for configuring QpiSnoopMode token.\n* `home-snoop` - Value - home-snoop for configuring QpiSnoopMode token.", "type": "string", "enum": [ "platform-default", "auto", "cluster-on-die", "early-snoop", "home-directory-snoop", "home-directory-snoop-with-osb", "home-snoop" ], "default": "platform-default", "x-omitempty": true }, "RankInterLeave": { "description": "BIOS Token for setting Rank Interleaving configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1-way` - Value - 1-way for configuring RankInterLeave token.\n* `2-way` - Value - 2-way for configuring RankInterLeave token.\n* `4-way` - Value - 4-way for configuring RankInterLeave token.\n* `8-way` - Value - 8-way for configuring RankInterLeave token.\n* `auto` - Value - auto for configuring RankInterLeave token.", "type": "string", "enum": [ "platform-default", "1-way", "2-way", "4-way", "8-way", "auto" ], "default": "platform-default", "x-omitempty": true }, "RedirectionAfterPost": { "description": "BIOS Token for setting Redirection After BIOS POST configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Always Enable` - Value - Always Enable for configuring RedirectionAfterPost token.\n* `Bootloader` - Value - Bootloader for configuring RedirectionAfterPost token.", "type": "string", "enum": [ "platform-default", "Always Enable", "Bootloader" ], "default": "platform-default", "x-omitempty": true }, "ResizeBarSupport": { "description": "BIOS Token for setting Re-Size BAR Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "RuntimePostPackageRepair": { "description": "BIOS Token for setting Runtime Post Package Repair configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SataModeSelect": { "description": "BIOS Token for setting SATA Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `AHCI` - Value - AHCI for configuring SataModeSelect token.\n* `Disabled` - Value - Disabled for configuring SataModeSelect token.\n* `LSI SW RAID` - Value - LSI SW RAID for configuring SataModeSelect token.", "type": "string", "enum": [ "platform-default", "AHCI", "Disabled", "LSI SW RAID" ], "default": "platform-default", "x-omitempty": true }, "SelectMemoryRasConfiguration": { "description": "BIOS Token for setting Memory RAS Configuration configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `adddc-sparing` - Value - adddc-sparing for configuring SelectMemoryRasConfiguration token.\n* `lockstep` - Value - lockstep for configuring SelectMemoryRasConfiguration token.\n* `maximum-performance` - Value - maximum-performance for configuring SelectMemoryRasConfiguration token.\n* `mirror-mode-1lm` - Value - mirror-mode-1lm for configuring SelectMemoryRasConfiguration token.\n* `mirroring` - Value - mirroring for configuring SelectMemoryRasConfiguration token.\n* `partial-mirror-mode-1lm` - Value - partial-mirror-mode-1lm for configuring SelectMemoryRasConfiguration token.\n* `sparing` - Value - sparing for configuring SelectMemoryRasConfiguration token.", "type": "string", "enum": [ "platform-default", "adddc-sparing", "lockstep", "maximum-performance", "mirror-mode-1lm", "mirroring", "partial-mirror-mode-1lm", "sparing" ], "default": "platform-default", "x-omitempty": true }, "SelectPprType": { "description": "BIOS Token for setting PPR Type configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SelectPprType token.\n* `Hard PPR` - Value - Hard PPR for configuring SelectPprType token.\n* `Soft PPR` - Value - Soft PPR for configuring SelectPprType token.", "type": "string", "enum": [ "platform-default", "disabled", "Hard PPR", "Soft PPR" ], "default": "platform-default", "x-omitempty": true }, "SerialMux": { "description": "BIOS Token for setting Serial Mux configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SerialPortAenable": { "description": "BIOS Token for setting Serial A Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Sev": { "description": "BIOS Token for setting Secured Encrypted Virtualization configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `253 ASIDs` - Value - 253 ASIDs for configuring Sev token.\n* `509 ASIDs` - Value - 509 ASIDs for configuring Sev token.\n* `Auto` - Value - Auto for configuring Sev token.", "type": "string", "enum": [ "platform-default", "253 ASIDs", "509 ASIDs", "Auto" ], "default": "platform-default", "x-omitempty": true }, "SgxAutoRegistrationAgent": { "description": "BIOS Token for setting SGX Auto MP Registration Agent configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SgxEpoch0": { "description": "BIOS Token for setting SGX Epoch 0 configuration (0 - ffffffffffffffff Hash byte 7-0).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxEpoch1": { "description": "BIOS Token for setting SGX Epoch 1 configuration (0 - ffffffffffffffff Hash byte 7-0).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxFactoryReset": { "description": "BIOS Token for setting SGX Factory Reset configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SgxLePubKeyHash0": { "description": "BIOS Token for setting SGX PubKey Hash0 configuration (0 - ffffffffffffffff Hash byte 7-0).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxLePubKeyHash1": { "description": "BIOS Token for setting SGX PubKey Hash1 configuration (0 - ffffffffffffffff Hash byte 15-8).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxLePubKeyHash2": { "description": "BIOS Token for setting SGX PubKey Hash2 configuration (0 - ffffffffffffffff Hash byte 23-16).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxLePubKeyHash3": { "description": "BIOS Token for setting SGX PubKey Hash3 configuration (0 - ffffffffffffffff Hash byte 31-24).", "type": "string", "default": "platform-default", "pattern": "^([0-9a-fA-F]{1,16})$|^(platform-default)$", "x-omitempty": true }, "SgxLeWr": { "description": "BIOS Token for setting SGX Write Enable configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SgxPackageInfoInBandAccess": { "description": "BIOS Token for setting SGX Package Information In-Band Access configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SgxQos": { "description": "BIOS Token for setting SGX QoS configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Sha1pcrBank": { "description": "BIOS Token for setting SHA-1 PCR Bank configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Sha256pcrBank": { "description": "BIOS Token for setting SHA256 PCR Bank configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Sha384pcrBank": { "description": "BIOS Token for setting SHA384 PCR Bank configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SinglePctlEnable": { "description": "BIOS Token for setting Single PCTL configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `No` - Value - No for configuring SinglePctlEnable token.\n* `Yes` - Value - Yes for configuring SinglePctlEnable token.", "type": "string", "enum": [ "platform-default", "No", "Yes" ], "default": "platform-default", "x-omitempty": true }, "Slot10linkSpeed": { "description": "BIOS Token for setting PCIe Slot:10 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot10linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot10linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot10linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot10linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot10linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "Slot10state": { "description": "BIOS Token for setting Slot 10 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot10state token.\n* `enabled` - Value - enabled for configuring Slot10state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot10state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot10state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot11linkSpeed": { "description": "BIOS Token for setting PCIe Slot:11 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot11linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot11linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot11linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot11linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot11linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "Slot11state": { "description": "BIOS Token for setting Slot 11 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Slot12linkSpeed": { "description": "BIOS Token for setting PCIe Slot:12 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot12linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot12linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot12linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot12linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot12linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "Slot12state": { "description": "BIOS Token for setting Slot 12 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Slot13state": { "description": "BIOS Token for setting Slot 13 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Slot14state": { "description": "BIOS Token for setting Slot 14 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Slot1linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot1linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot1linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot1state": { "description": "BIOS Token for setting Slot 1 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot1state token.\n* `enabled` - Value - enabled for configuring Slot1state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot1state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot1state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot2linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot2linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot2linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot2state": { "description": "BIOS Token for setting Slot 2 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot2state token.\n* `enabled` - Value - enabled for configuring Slot2state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot2state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot2state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot3linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 3 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot3linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot3linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot3linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot3linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot3linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot3linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot3linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot3state": { "description": "BIOS Token for setting Slot 3 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot3state token.\n* `enabled` - Value - enabled for configuring Slot3state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot3state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot3state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot4linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 4 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot4linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot4linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot4linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot4linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot4linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot4linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot4linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot4state": { "description": "BIOS Token for setting Slot 4 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot4state token.\n* `enabled` - Value - enabled for configuring Slot4state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot4state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot4state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot5linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 5 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot5linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot5linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot5linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot5linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot5linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot5linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot5linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot5state": { "description": "BIOS Token for setting Slot 5 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot5state token.\n* `enabled` - Value - enabled for configuring Slot5state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot5state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot5state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot6linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 6 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot6linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot6linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot6linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot6linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot6linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot6linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot6linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot6state": { "description": "BIOS Token for setting Slot 6 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot6state token.\n* `enabled` - Value - enabled for configuring Slot6state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot6state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot6state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot7linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 7 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot7linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot7linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot7linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot7linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot7linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot7linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot7linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot7state": { "description": "BIOS Token for setting Slot 7 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot7state token.\n* `enabled` - Value - enabled for configuring Slot7state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot7state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot7state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot8linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 8 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot8linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot8linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot8linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot8linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot8linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot8linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring Slot8linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "Slot8state": { "description": "BIOS Token for setting Slot 8 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot8state token.\n* `enabled` - Value - enabled for configuring Slot8state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot8state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot8state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "Slot9linkSpeed": { "description": "BIOS Token for setting PCIe Slot: 9 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Slot9linkSpeed token.\n* `Disabled` - Value - Disabled for configuring Slot9linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring Slot9linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring Slot9linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring Slot9linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring Slot9linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4" ], "default": "platform-default", "x-omitempty": true }, "Slot9state": { "description": "BIOS Token for setting Slot 9 State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring Slot9state token.\n* `enabled` - Value - enabled for configuring Slot9state token.\n* `Legacy Only` - Value - Legacy Only for configuring Slot9state token.\n* `UEFI Only` - Value - UEFI Only for configuring Slot9state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotFlomLinkSpeed": { "description": "BIOS Token for setting PCIe Slot:FLOM Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFlomLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFlomLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFlomLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFlomLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFlomLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme10linkSpeed": { "description": "BIOS Token for setting Front NVME 10 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme10linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme10linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme10linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme10linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme10linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme10linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme10linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme10optionRom": { "description": "BIOS Token for setting Front NVME 10 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme11linkSpeed": { "description": "BIOS Token for setting Front NVME 11 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme11linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme11linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme11linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme11linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme11linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme11linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme11linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme11optionRom": { "description": "BIOS Token for setting Front NVME 11 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme12linkSpeed": { "description": "BIOS Token for setting Front NVME 12 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme12linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme12linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme12linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme12linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme12linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme12linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme12linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme12optionRom": { "description": "BIOS Token for setting Front NVME 12 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme13linkSpeed": { "description": "BIOS Token for setting Front NVME 13 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme13linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme13linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme13linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme13linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme13linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme13linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme13linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme13optionRom": { "description": "BIOS Token for setting Front NVME 13 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme14linkSpeed": { "description": "BIOS Token for setting Front NVME 14 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme14linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme14linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme14linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme14linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme14linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme14linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme14linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme14optionRom": { "description": "BIOS Token for setting Front NVME 14 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme15linkSpeed": { "description": "BIOS Token for setting Front NVME 15 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme15linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme15linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme15linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme15linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme15linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme15linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme15linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme15optionRom": { "description": "BIOS Token for setting Front NVME 15 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme16linkSpeed": { "description": "BIOS Token for setting Front NVME 16 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme16linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme16linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme16linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme16linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme16linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme16linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme16linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme16optionRom": { "description": "BIOS Token for setting Front NVME 16 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme17linkSpeed": { "description": "BIOS Token for setting Front NVME 17 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme17linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme17linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme17linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme17linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme17linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme17linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme17linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme17optionRom": { "description": "BIOS Token for setting Front NVME 17 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme18linkSpeed": { "description": "BIOS Token for setting Front NVME 18 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme18linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme18linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme18linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme18linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme18linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme18linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme18linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme18optionRom": { "description": "BIOS Token for setting Front NVME 18 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme19linkSpeed": { "description": "BIOS Token for setting Front NVME 19 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme19linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme19linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme19linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme19linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme19linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme19linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme19linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme19optionRom": { "description": "BIOS Token for setting Front NVME 19 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme1linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme1linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme1linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme1optionRom": { "description": "BIOS Token for setting Front NVME 1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme20linkSpeed": { "description": "BIOS Token for setting Front NVME 20 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme20linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme20linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme20linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme20linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme20linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme20linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme20linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme20optionRom": { "description": "BIOS Token for setting Front NVME 20 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme21linkSpeed": { "description": "BIOS Token for setting Front NVME 21 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme21linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme21linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme21linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme21linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme21linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme21linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme21linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme21optionRom": { "description": "BIOS Token for setting Front NVME 21 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme22linkSpeed": { "description": "BIOS Token for setting Front NVME 22 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme22linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme22linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme22linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme22linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme22linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme22linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme22linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme22optionRom": { "description": "BIOS Token for setting Front NVME 22 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme23linkSpeed": { "description": "BIOS Token for setting Front NVME 23 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme23linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme23linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme23linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme23linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme23linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme23linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme23linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme23optionRom": { "description": "BIOS Token for setting Front NVME 23 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme24linkSpeed": { "description": "BIOS Token for setting Front NVME 24 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme24linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme24linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme24linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme24linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme24linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme24linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme24linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme24optionRom": { "description": "BIOS Token for setting Front NVME 24 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme25linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 25 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme25linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme25linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme25linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme25linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme25linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme25linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme25linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme25optionRom": { "description": "BIOS Token for setting Front NVME 25 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme26linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 26 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme26linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme26linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme26linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme26linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme26linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme26linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme26linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme26optionRom": { "description": "BIOS Token for setting Front NVME 26 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme27linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 27 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme27linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme27linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme27linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme27linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme27linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme27linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme27linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme27optionRom": { "description": "BIOS Token for setting Front NVME 27 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme28linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 28 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme28linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme28linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme28linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme28linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme28linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme28linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme28linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme28optionRom": { "description": "BIOS Token for setting Front NVME 28 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme29linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 29 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme29linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme29linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme29linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme29linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme29linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme29linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme29linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme29optionRom": { "description": "BIOS Token for setting Front NVME 29 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme2linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme2linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme2linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme2optionRom": { "description": "BIOS Token for setting Front NVME 2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme30linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 30 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme30linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme30linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme30linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme30linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme30linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme30linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme30linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme30optionRom": { "description": "BIOS Token for setting Front NVME 30 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme31linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 31 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme31linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme31linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme31linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme31linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme31linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme31linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme31linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme31optionRom": { "description": "BIOS Token for setting Front NVME 31 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme32linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 32 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme32linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme32linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme32linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme32linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme32linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme32linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme32linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme32optionRom": { "description": "BIOS Token for setting Front NVME 32 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme3linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 3 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme3linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme3linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme3linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme3linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme3linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme3linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme3linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme3optionRom": { "description": "BIOS Token for setting Front NVME 3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme4linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front NVME 4 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme4linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme4linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme4linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme4linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme4linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme4linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme4linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme4optionRom": { "description": "BIOS Token for setting Front NVME 4 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme5linkSpeed": { "description": "BIOS Token for setting Front NVME 5 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme5linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme5linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme5linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme5linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme5linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme5linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme5linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme5optionRom": { "description": "BIOS Token for setting Front NVME 5 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme6linkSpeed": { "description": "BIOS Token for setting Front NVME 6 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme6linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme6linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme6linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme6linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme6linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme6linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme6linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme6optionRom": { "description": "BIOS Token for setting Front NVME 6 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme7linkSpeed": { "description": "BIOS Token for setting Front NVME 7 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme7linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme7linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme7linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme7linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme7linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme7linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme7linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme7optionRom": { "description": "BIOS Token for setting Front NVME 7 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme8linkSpeed": { "description": "BIOS Token for setting Front NVME 8 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme8linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme8linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme8linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme8linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme8linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme8linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme8linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme8optionRom": { "description": "BIOS Token for setting Front NVME 8 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme9linkSpeed": { "description": "BIOS Token for setting Front NVME 9 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontNvme9linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontNvme9linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontNvme9linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontNvme9linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontNvme9linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotFrontNvme9linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotFrontNvme9linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontNvme9optionRom": { "description": "BIOS Token for setting Front NVME 9 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontSlot5linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontSlot5linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontSlot5linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontSlot5linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontSlot5linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontSlot5linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotFrontSlot6linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Front2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotFrontSlot6linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotFrontSlot6linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotFrontSlot6linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotFrontSlot6linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotFrontSlot6linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu1state": { "description": "BIOS Token for setting GPU 1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu2state": { "description": "BIOS Token for setting GPU 2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu3state": { "description": "BIOS Token for setting GPU 3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu4state": { "description": "BIOS Token for setting GPU 4 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu5state": { "description": "BIOS Token for setting GPU 5 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu6state": { "description": "BIOS Token for setting GPU 6 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu7state": { "description": "BIOS Token for setting GPU 7 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotGpu8state": { "description": "BIOS Token for setting GPU 8 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotHbaLinkSpeed": { "description": "BIOS Token for setting PCIe Slot:HBA Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotHbaLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotHbaLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotHbaLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotHbaLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotHbaLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotHbaState": { "description": "BIOS Token for setting PCIe Slot:HBA OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotHbaState token.\n* `enabled` - Value - enabled for configuring SlotHbaState token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotHbaState token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotHbaState token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotLom1link": { "description": "BIOS Token for setting PCIe LOM:1 Link configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotLom2link": { "description": "BIOS Token for setting PCIe LOM:2 Link configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotMezzState": { "description": "BIOS Token for setting Slot Mezz State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotMezzState token.\n* `enabled` - Value - enabled for configuring SlotMezzState token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotMezzState token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotMezzState token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotMlomLinkSpeed": { "description": "BIOS Token for setting PCIe Slot:MLOM Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotMlomLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotMlomLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotMlomLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotMlomLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotMlomLinkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotMlomLinkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotMlomLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotMlomState": { "description": "BIOS Token for setting PCIe Slot MLOM OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotMlomState token.\n* `enabled` - Value - enabled for configuring SlotMlomState token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotMlomState token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotMlomState token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotMraidLinkSpeed": { "description": "BIOS Token for setting MRAID Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotMraidLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotMraidLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotMraidLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotMraidLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotMraidLinkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotMraidLinkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotMraidLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotMraidState": { "description": "BIOS Token for setting PCIe Slot MRAID OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN10state": { "description": "BIOS Token for setting PCIe Slot N10 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN11state": { "description": "BIOS Token for setting PCIe Slot N11 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN12state": { "description": "BIOS Token for setting PCIe Slot N12 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN13state": { "description": "BIOS Token for setting PCIe Slot N13 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN14state": { "description": "BIOS Token for setting PCIe Slot N14 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN15state": { "description": "BIOS Token for setting PCIe Slot N15 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN16state": { "description": "BIOS Token for setting PCIe Slot N16 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN17state": { "description": "BIOS Token for setting PCIe Slot N17 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN18state": { "description": "BIOS Token for setting PCIe Slot N18 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN19state": { "description": "BIOS Token for setting PCIe Slot N19 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN1state": { "description": "BIOS Token for setting PCIe Slot N1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotN1state token.\n* `enabled` - Value - enabled for configuring SlotN1state token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotN1state token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotN1state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotN20state": { "description": "BIOS Token for setting PCIe Slot N20 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN21state": { "description": "BIOS Token for setting PCIe Slot N21 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN22state": { "description": "BIOS Token for setting PCIe Slot N22 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN23state": { "description": "BIOS Token for setting PCIe Slot N23 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN24state": { "description": "BIOS Token for setting PCIe Slot N24 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN2state": { "description": "BIOS Token for setting PCIe Slot N2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotN2state token.\n* `enabled` - Value - enabled for configuring SlotN2state token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotN2state token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotN2state token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotN3state": { "description": "BIOS Token for setting PCIe Slot N3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN4state": { "description": "BIOS Token for setting PCIe Slot N4 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN5state": { "description": "BIOS Token for setting PCIe Slot N5 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN6state": { "description": "BIOS Token for setting PCIe Slot N6 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN7state": { "description": "BIOS Token for setting PCIe Slot N7 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN8state": { "description": "BIOS Token for setting PCIe Slot N8 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotN9state": { "description": "BIOS Token for setting PCIe Slot N9 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRaidLinkSpeed": { "description": "BIOS Token for setting RAID Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRaidLinkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRaidLinkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRaidLinkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRaidLinkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRaidLinkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRaidState": { "description": "BIOS Token for setting PCIe Slot RAID OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme1linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRearNvme1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRearNvme1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRearNvme1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRearNvme1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRearNvme1linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotRearNvme1linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotRearNvme1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme1state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 1 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme2linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRearNvme2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRearNvme2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRearNvme2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRearNvme2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRearNvme2linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotRearNvme2linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotRearNvme2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme2state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 2 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme3linkSpeed": { "description": "BIOS Token for setting Rear NVME 3 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRearNvme3linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRearNvme3linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRearNvme3linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRearNvme3linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRearNvme3linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotRearNvme3linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotRearNvme3linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme3state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 3 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme4linkSpeed": { "description": "BIOS Token for setting Rear NVME 4 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRearNvme4linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRearNvme4linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRearNvme4linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRearNvme4linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRearNvme4linkSpeed token.\n* `GEN4` - Value - GEN4 for configuring SlotRearNvme4linkSpeed token.\n* `GEN5` - Value - GEN5 for configuring SlotRearNvme4linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3", "GEN4", "GEN5" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme4state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 4 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme5state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 5 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme6state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 6 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme7state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 7 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRearNvme8state": { "description": "BIOS Token for setting PCIe Slot:Rear NVME 8 OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser1linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser1slot1linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser1 Slot1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser1slot1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser1slot1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser1slot1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser1slot1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser1slot1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser1slot2linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser1 Slot2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser1slot2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser1slot2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser1slot2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser1slot2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser1slot2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser1slot3linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser1 Slot3 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser1slot3linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser1slot3linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser1slot3linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser1slot3linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser1slot3linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser2linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser2slot4linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser2 Slot4 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser2slot4linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser2slot4linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser2slot4linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser2slot4linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser2slot4linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser2slot5linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser2 Slot5 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser2slot5linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser2slot5linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser2slot5linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser2slot5linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser2slot5linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotRiser2slot6linkSpeed": { "description": "BIOS Token for setting PCIe Slot:Riser2 Slot6 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotRiser2slot6linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotRiser2slot6linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotRiser2slot6linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotRiser2slot6linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotRiser2slot6linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotSasState": { "description": "BIOS Token for setting PCIe Slot:SAS OptionROM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring SlotSasState token.\n* `enabled` - Value - enabled for configuring SlotSasState token.\n* `Legacy Only` - Value - Legacy Only for configuring SlotSasState token.\n* `UEFI Only` - Value - UEFI Only for configuring SlotSasState token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Legacy Only", "UEFI Only" ], "default": "platform-default", "x-omitempty": true }, "SlotSsdSlot1linkSpeed": { "description": "BIOS Token for setting PCIe Slot:FrontSSD1 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotSsdSlot1linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotSsdSlot1linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotSsdSlot1linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotSsdSlot1linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotSsdSlot1linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "SlotSsdSlot2linkSpeed": { "description": "BIOS Token for setting PCIe Slot:FrontSSD2 Link Speed configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SlotSsdSlot2linkSpeed token.\n* `Disabled` - Value - Disabled for configuring SlotSsdSlot2linkSpeed token.\n* `GEN1` - Value - GEN1 for configuring SlotSsdSlot2linkSpeed token.\n* `GEN2` - Value - GEN2 for configuring SlotSsdSlot2linkSpeed token.\n* `GEN3` - Value - GEN3 for configuring SlotSsdSlot2linkSpeed token.", "type": "string", "enum": [ "platform-default", "Auto", "Disabled", "GEN1", "GEN2", "GEN3" ], "default": "platform-default", "x-omitempty": true }, "Smee": { "description": "BIOS Token for setting SMEE configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SmtMode": { "description": "BIOS Token for setting SMT Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring SmtMode token.\n* `Off` - Value - Off for configuring SmtMode token.", "type": "string", "enum": [ "platform-default", "Auto", "Off" ], "default": "platform-default", "x-omitempty": true }, "Snc": { "description": "BIOS Token for setting Sub Numa Clustering configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Snc token.\n* `disabled` - Value - disabled for configuring Snc token.\n* `enabled` - Value - enabled for configuring Snc token.\n* `SNC2` - Value - SNC2 for configuring Snc token.\n* `SNC4` - Value - SNC4 for configuring Snc token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled", "SNC2", "SNC4" ], "default": "platform-default", "x-omitempty": true }, "SnoopyModeFor2lm": { "description": "BIOS Token for setting Snoopy Mode for 2LM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SnoopyModeForAd": { "description": "BIOS Token for setting Snoopy Mode for AD configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SparingMode": { "description": "BIOS Token for setting Sparing Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `dimm-sparing` - Value - dimm-sparing for configuring SparingMode token.\n* `rank-sparing` - Value - rank-sparing for configuring SparingMode token.", "type": "string", "enum": [ "platform-default", "dimm-sparing", "rank-sparing" ], "default": "platform-default", "x-omitempty": true }, "SpeculativeLockEnable": { "description": "BIOS Token for setting Speculative Lock configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "SrIov": { "description": "BIOS Token for setting SR-IOV Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "StreamerPrefetch": { "description": "BIOS Token for setting DCU Streamer Prefetch configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring StreamerPrefetch token.\n* `disabled` - Value - disabled for configuring StreamerPrefetch token.\n* `enabled` - Value - enabled for configuring StreamerPrefetch token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "SvmMode": { "description": "BIOS Token for setting SVM Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "TerminalType": { "description": "BIOS Token for setting Terminal Type configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `pc-ansi` - Value - pc-ansi for configuring TerminalType token.\n* `vt100` - Value - vt100 for configuring TerminalType token.\n* `vt100-plus` - Value - vt100-plus for configuring TerminalType token.\n* `vt-utf8` - Value - vt-utf8 for configuring TerminalType token.", "type": "string", "enum": [ "platform-default", "pc-ansi", "vt100", "vt100-plus", "vt-utf8" ], "default": "platform-default", "x-omitempty": true }, "TpmControl": { "description": "BIOS Token for setting Trusted Platform Module State configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "TpmPendingOperation": { "description": "BIOS Token for setting TPM Pending Operation configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `None` - Value - None for configuring TpmPendingOperation token.\n* `TpmClear` - Value - TpmClear for configuring TpmPendingOperation token.", "type": "string", "enum": [ "platform-default", "None", "TpmClear" ], "default": "platform-default", "x-omitempty": true }, "TpmPpiRequired": { "description": "BIOS Token for setting TPM Minimal Physical Presence configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "TpmSupport": { "description": "BIOS Token for setting Security Device Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "Tsme": { "description": "BIOS Token for setting Transparent Secure Memory Encryption configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring Tsme token.\n* `disabled` - Value - disabled for configuring Tsme token.\n* `enabled` - Value - enabled for configuring Tsme token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "TxtSupport": { "description": "BIOS Token for setting Intel Trusted Execution Technology Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UcsmBootOrderRule": { "description": "BIOS Token for setting Boot Order Rules configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Loose` - Value - Loose for configuring UcsmBootOrderRule token.\n* `Strict` - Value - Strict for configuring UcsmBootOrderRule token.", "type": "string", "enum": [ "platform-default", "Loose", "Strict" ], "default": "platform-default", "x-omitempty": true }, "UefiMemMapSpFlagEn": { "description": "BIOS Token for setting UEFI Memory Map Special Purpose Memory Flag configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UfsDisable": { "description": "BIOS Token for setting Uncore Frequency Scaling configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `disabled` - Value - disabled for configuring UfsDisable token.\n* `enabled` - Value - enabled for configuring UfsDisable token.\n* `Mode 0` - Value - Mode 0 for configuring UfsDisable token.\n* `Mode 1` - Value - Mode 1 for configuring UfsDisable token.", "type": "string", "enum": [ "platform-default", "disabled", "enabled", "Mode 0", "Mode 1" ], "default": "platform-default", "x-omitempty": true }, "UfsDisableIo": { "description": "BIOS Token for setting Uncore Frequency Scaling IO configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Mode 0` - Value - Mode 0 for configuring UfsDisableIo token.\n* `Mode 1` - Value - Mode 1 for configuring UfsDisableIo token.", "type": "string", "enum": [ "platform-default", "Mode 0", "Mode 1" ], "default": "platform-default", "x-omitempty": true }, "UmaBasedClustering": { "description": "BIOS Token for setting UMA Based Clustering configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Disable (All2All)` - Value - Disable (All2All) for configuring UmaBasedClustering token.\n* `Hemisphere (2-clusters)` - Value - Hemisphere (2-clusters) for configuring UmaBasedClustering token.\n* `Quadrant (4-clusters)` - Value - Quadrant (4-clusters) for configuring UmaBasedClustering token.", "type": "string", "enum": [ "platform-default", "Disable (All2All)", "Hemisphere (2-clusters)", "Quadrant (4-clusters)" ], "default": "platform-default", "x-omitempty": true }, "UpiLinkEnablement": { "description": "BIOS Token for setting UPI Link Enablement configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1` - Value - 1 for configuring UpiLinkEnablement token.\n* `2` - Value - 2 for configuring UpiLinkEnablement token.\n* `3` - Value - 3 for configuring UpiLinkEnablement token.\n* `Auto` - Value - Auto for configuring UpiLinkEnablement token.", "type": "string", "enum": [ "platform-default", "1", "2", "3", "Auto" ], "default": "platform-default", "x-omitempty": true }, "UpiPowerManagement": { "description": "BIOS Token for setting UPI Power Manangement configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbEmul6064": { "description": "BIOS Token for setting Port 60/64 Emulation configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortFront": { "description": "BIOS Token for setting USB Port Front configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortInternal": { "description": "BIOS Token for setting USB Port Internal configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortKvm": { "description": "BIOS Token for setting USB Port KVM configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortRear": { "description": "BIOS Token for setting USB Port Rear configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortSdCard": { "description": "BIOS Token for setting USB Port SD Card configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbPortVmedia": { "description": "BIOS Token for setting USB Port VMedia configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "UsbXhciSupport": { "description": "BIOS Token for setting XHCI Legacy Support configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "VgaPriority": { "description": "BIOS Token for setting VGA Priority configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Offboard` - Value - Offboard for configuring VgaPriority token.\n* `Onboard` - Value - Onboard for configuring VgaPriority token.\n* `Onboard VGA Disabled` - Value - Onboard VGA Disabled for configuring VgaPriority token.", "type": "string", "enum": [ "platform-default", "Offboard", "Onboard", "Onboard VGA Disabled" ], "default": "platform-default", "x-omitempty": true }, "VirtualNuma": { "description": "BIOS Token for setting Virtual NUMA configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "VmdEnable": { "description": "BIOS Token for setting VMD Enablement configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "VolMemoryMode": { "description": "BIOS Token for setting Volatile Memory Mode configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `1LM` - Value - 1LM for configuring VolMemoryMode token.\n* `2LM` - Value - 2LM for configuring VolMemoryMode token.", "type": "string", "enum": [ "platform-default", "1LM", "2LM" ], "default": "platform-default", "x-omitempty": true }, "WorkLoadConfig": { "description": "BIOS Token for setting Workload Configuration configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Balanced` - Value - Balanced for configuring WorkLoadConfig token.\n* `I/O Sensitive` - Value - I/O Sensitive for configuring WorkLoadConfig token.\n* `NUMA` - Value - NUMA for configuring WorkLoadConfig token.\n* `UMA` - Value - UMA for configuring WorkLoadConfig token.", "type": "string", "enum": [ "platform-default", "Balanced", "I/O Sensitive", "NUMA", "UMA" ], "default": "platform-default", "x-omitempty": true }, "X2apicOptOut": { "description": "BIOS Token for setting X2APIC Opt-Out Flag configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `enabled` - Enables the BIOS setting.\n* `disabled` - Disables the BIOS setting.", "type": "string", "enum": [ "platform-default", "enabled", "disabled" ], "default": "platform-default", "x-omitempty": true }, "XptPrefetch": { "description": "BIOS Token for setting XPT Prefetch configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring XptPrefetch token.\n* `disabled` - Value - disabled for configuring XptPrefetch token.\n* `enabled` - Value - enabled for configuring XptPrefetch token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "XptRemotePrefetch": { "description": "BIOS Token for setting XPT Remote Prefetch configuration.\n* `platform-default` - Default value used by the platform for the BIOS setting.\n* `Auto` - Value - Auto for configuring XptRemotePrefetch token.\n* `disabled` - Value - disabled for configuring XptRemotePrefetch token.\n* `enabled` - Value - enabled for configuring XptRemotePrefetch token.", "type": "string", "enum": [ "platform-default", "Auto", "disabled", "enabled" ], "default": "platform-default", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "bios.Policy.List": { "title": "List of 'bios.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.Policy" }, "nullable": true } } } ] }, "bios.Ptt000C845BiosToken": { "title": "Bios:Ptt000 C845 Bios Token", "description": "PTT000 bios token property.", "x-allOf-name": "bios.Ptt000C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ptt000C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ptt000C845BiosToken" ], "default": "bios.Ptt000C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ptt000C845BiosToken" ], "default": "bios.Ptt000C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enables or disables boot with initialization of a minimal set of devices required to launch active boot option. Has no effect for BBS boot options.\n* `Disabled` - Value -- Disabled for configuring Ptt000 token.\n* `Enabled` - Value -- Enabled for configuring Ptt000 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.SystemBootOrder.Response": { "description": "The response body of a HTTP GET request for the 'bios.SystemBootOrder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.SystemBootOrder' resources.", "x-one-of-name": "bios.SystemBootOrder.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.SystemBootOrder.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.SystemBootOrder.Relationship": { "description": "A relationship to the 'bios.SystemBootOrder' resource, or the expanded 'bios.SystemBootOrder' resource, or the 'null' value.", "x-one-of-name": "bios.SystemBootOrder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.SystemBootOrder" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.SystemBootOrder": { "title": "Bios:System Boot Order", "description": "The BIOS.SystemBootOrder object represents the actual boot order of a server as enumerated by its BIOS. This provides a comprehensive, read-only view of the boot sequence, including the configured boot mode and the list of bootable devices.\n#### Purpose\nThe SystemBootOrder object is designed to provide a definitive inventory of how a server will attempt to boot. It captures not only the sequence of devices but also the overarching boot mode (Legacy or UEFI) and the status of Secure Boot. It is essential for verifying boot configurations and troubleshooting boot-related issues.\n#### Key Concepts\n- **Actual Boot Sequence:** Lists the bootDevices in the precise order that the BIOS will use them.\n- **Boot Mode and Security:** Reports the configured bootMode (Legacy/Uefi) and the secureBoot state, providing a complete picture of the boot environment.\n- **Read-Only Inventory:** Acts as a source of truth for the server's current boot configuration, as opposed to a policy object that defines a desired state.\n- **Hierarchical Structure:** Contains a collection of BIOS.BootDevice objects, each representing a specific device in the boot sequence.", "x-allOf-name": "bios.SystemBootOrder", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.SystemBootOrder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.SystemBootOrder" ], "default": "bios.SystemBootOrder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.SystemBootOrder" ], "default": "bios.SystemBootOrder", "x-enum-as-string": true }, "BootMode": { "description": "The BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the MBR partitioning scheme.\n* `Legacy` - Legacy mode refers to the traditional process of booting from BIOS. Legacy mode uses the MBR to locate the bootloader.\n* `Uefi` - UEFI mode uses the GUID Partition Table (GPT) to locate EFI Service Partitions to boot from.", "type": "string", "enum": [ "Legacy", "Uefi" ], "default": "Legacy", "readOnly": true, "x-omitempty": true }, "SecureBoot": { "description": "Secure boot if set to enabled, enforces that device boots using only software that is trusted by the Original Equipment Manufacturer (OEM).\n* `NotAvailable` - Set the state of Secure Boot to Not Available.\n* `Disabled` - Set the state of Secure Boot to Disabled.\n* `Enabled` - Set the state of Secure Boot to Enabled.", "type": "string", "enum": [ "NotAvailable", "Disabled", "Enabled" ], "default": "NotAvailable", "readOnly": true, "x-omitempty": true }, "BiosUnit": { "$ref": "#/components/schemas/bios.Unit.Relationship", "description": "A reference to a biosUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BootDevices": { "description": "An array of relationships to biosBootDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/bios.BootDevice.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bios.SystemBootOrder.List": { "title": "List of 'bios.SystemBootOrder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.SystemBootOrder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.SystemBootOrder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.SystemBootOrder" }, "nullable": true } } } ] }, "bios.Tcg001C845BiosToken": { "title": "Bios:Tcg001 C845 Bios Token", "description": "TCG001 bios token property.", "x-allOf-name": "bios.Tcg001C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Tcg001C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Tcg001C845BiosToken" ], "default": "bios.Tcg001C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Tcg001C845BiosToken" ], "default": "bios.Tcg001C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable/Disable Security Device. NOTE: Your Computer will reboot during restart in order to change State of the Device.\n* `Enabled` - Value -- Enabled for configuring Tcg001 token.\n* `Disabled` - Value -- Disabled for configuring Tcg001 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Tcg003C845BiosToken": { "title": "Bios:Tcg003 C845 Bios Token", "description": "TCG003 bios token property.", "x-allOf-name": "bios.Tcg003C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Tcg003C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Tcg003C845BiosToken" ], "default": "bios.Tcg003C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Tcg003C845BiosToken" ], "default": "bios.Tcg003C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enables or Disables BIOS support for security device. O.S. will not show Security Device. TCG EFI protocol and INT1A interface will not be available.\n* `Enabled` - Value -- Enabled for configuring Tcg003 token.\n* `Disabled` - Value -- Disabled for configuring Tcg003 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Tcg007C845BiosToken": { "title": "Bios:Tcg007 C845 Bios Token", "description": "TCG007 bios token property.", "x-allOf-name": "bios.Tcg007C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Tcg007C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Tcg007C845BiosToken" ], "default": "bios.Tcg007C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Tcg007C845BiosToken" ], "default": "bios.Tcg007C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Schedule an Operation for the Security Device. NOTE: Your Computer will reboot during restart in order to change State of Security Device.\n* `None` - Value -- None for configuring Tcg007 token.\n* `TPM Clear` - Value -- TPM Clear for configuring Tcg007 token.", "type": "string", "enum": [ "None", "TPM Clear" ], "default": "None", "x-omitempty": true } } } ] }, "bios.Tcg018C845BiosToken": { "title": "Bios:Tcg018 C845 Bios Token", "description": "TCG018 bios token property.", "x-allOf-name": "bios.Tcg018C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Tcg018C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Tcg018C845BiosToken" ], "default": "bios.Tcg018C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Tcg018C845BiosToken" ], "default": "bios.Tcg018C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable SHA256 PCR Bank.\n* `Enabled` - Value -- Enabled for configuring Tcg018 token.\n* `Disabled` - Value -- Disabled for configuring Tcg018 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Tcg019C845BiosToken": { "title": "Bios:Tcg019 C845 Bios Token", "description": "TCG019 bios token property.", "x-allOf-name": "bios.Tcg019C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Tcg019C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Tcg019C845BiosToken" ], "default": "bios.Tcg019C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Tcg019C845BiosToken" ], "default": "bios.Tcg019C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Enable or Disable SHA384 PCR Bank.\n* `Disabled` - Value -- Disabled for configuring Tcg019 token.\n* `Enabled` - Value -- Enabled for configuring Tcg019 token.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true } } } ] }, "bios.Ter001C845BiosToken": { "title": "Bios:Ter001 C845 Bios Token", "description": "TER001 bios token property.", "x-allOf-name": "bios.Ter001C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ter001C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ter001C845BiosToken" ], "default": "bios.Ter001C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ter001C845BiosToken" ], "default": "bios.Ter001C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Console Redirection Enable or Disable.\n* `Enabled` - Value -- Enabled for configuring Ter001 token.\n* `Disabled` - Value -- Disabled for configuring Ter001 token.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true } } } ] }, "bios.Ter0021C845BiosToken": { "title": "Bios:Ter0021 C845 Bios Token", "description": "TER0021 bios token property.", "x-allOf-name": "bios.Ter0021C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ter0021C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ter0021C845BiosToken" ], "default": "bios.Ter0021C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ter0021C845BiosToken" ], "default": "bios.Ter0021C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Selects serial port transmission speed. The speed must be matched on the other side. Long or noisy lines may require lower speeds.\n* `115200` - Value -- 115200 for configuring Ter0021 token.\n* `9600` - Value -- 9600 for configuring Ter0021 token.\n* `19200` - Value -- 19200 for configuring Ter0021 token.\n* `38400` - Value -- 38400 for configuring Ter0021 token.\n* `57600` - Value -- 57600 for configuring Ter0021 token.\n* `230400` - Value -- 230400 for configuring Ter0021 token.\n* `460800` - Value -- 460800 for configuring Ter0021 token.\n* `921600` - Value -- 921600 for configuring Ter0021 token.", "type": "string", "enum": [ "115200", "9600", "19200", "38400", "57600", "230400", "460800", "921600" ], "default": "115200", "x-omitempty": true } } } ] }, "bios.Ter012C845BiosToken": { "title": "Bios:Ter012 C845 Bios Token", "description": "TER012 bios token property.", "x-allOf-name": "bios.Ter012C845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ter012C845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ter012C845BiosToken" ], "default": "bios.Ter012C845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ter012C845BiosToken" ], "default": "bios.Ter012C845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Emulation: ANSI: Extended ASCII char set. VT100: ASCII char set. VT100Plus: Extends VT100 to support color, function keys, etc. VT-UTF8: Uses UTF8 encoding to map Unicode chars onto 1 or more bytes.\n* `ANSI` - Value -- ANSI for configuring Ter012 token.\n* `VT100` - Value -- VT100 for configuring Ter012 token.\n* `VT100Plus` - Value -- VT100Plus for configuring Ter012 token.\n* `VT-UTF8` - Value -- VT-UTF8 for configuring Ter012 token.", "type": "string", "enum": [ "ANSI", "VT100", "VT100Plus", "VT-UTF8" ], "default": "ANSI", "x-omitempty": true } } } ] }, "bios.Ter05dC845BiosToken": { "title": "Bios:Ter05d C845 Bios Token", "description": "TER05D bios token property.", "x-allOf-name": "bios.Ter05dC845BiosToken", "allOf": [ { "$ref": "#/components/schemas/bios.C845BaseBiosToken" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Ter05dC845BiosToken', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Ter05dC845BiosToken" ], "default": "bios.Ter05dC845BiosToken", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Ter05dC845BiosToken" ], "default": "bios.Ter05dC845BiosToken", "x-enum-as-string": true }, "Value": { "description": "Flow control can prevent data loss from buffer overflow. When sending data, if the receiving buffers are full, a 'stop' signal can be sent to stop the data flow. Once the buffers are empty, a 'start' signal can be sent to re-start the flow. Hardware flow control uses two wires to send start/stop signals.\n* `None` - Value -- None for configuring Ter05d token.\n* `Hardware RTS/CTS` - Value -- Hardware RTS/CTS for configuring Ter05d token.", "type": "string", "enum": [ "None", "Hardware RTS/CTS" ], "default": "None", "x-omitempty": true } } } ] }, "bios.TokenSettings.Response": { "description": "The response body of a HTTP GET request for the 'bios.TokenSettings' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.TokenSettings' resources.", "x-one-of-name": "bios.TokenSettings.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.TokenSettings.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.TokenSettings.Relationship": { "description": "A relationship to the 'bios.TokenSettings' resource, or the expanded 'bios.TokenSettings' resource, or the 'null' value.", "x-one-of-name": "bios.TokenSettings.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.TokenSettings" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.TokenSettings": { "title": "Bios:Token Settings", "description": "The bios.TokenSettings object represents the status of a specific BIOS token, particularly for Memory Reliability, Availability, and Serviceability (RAS) configurations. It indicates whether a given RAS setting is currently active on the server.\n#### Purpose\nThe primary function of this object is to provide a granular view of which memory RAS feature is currently enabled in the BIOS. By querying this object, administrators can confirm if a setting like \"Sparing\" or \"Mirroring\" is the active configuration, which is crucial for verifying server resilience and performance settings.\n#### Key Concepts\n- **Granular Configuration State:** Provides the status (isAssigned) for a single, specific BIOS setting identified by settingsMoRn.\n- **Memory RAS Focus:** Specifically designed to report on memory-related RAS configurations, such as \"ADDDC-Sparing\" or \"Mirror-Mode-1LM\".\n- **Verification Tool:** Allows for programmatic verification that a desired memory RAS policy has been successfully applied to the server.\n- **Server-Specific Inventory:** Tied directly to a physical server, providing an accurate snapshot of its active BIOS token settings.", "x-allOf-name": "bios.TokenSettings", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.TokenSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.TokenSettings" ], "default": "bios.TokenSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.TokenSettings" ], "default": "bios.TokenSettings", "x-enum-as-string": true }, "IsAssigned": { "description": "Value that represents if the BIOS configuration is active. Possible values are \"yes\" and \"no\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "Parent server serial number.", "type": "string", "x-omitempty": true }, "SettingsMoRn": { "description": "BIOS configuration name as found in dn. Possible values are \"ADDDC-Sparing\", \"Maximum-Performance\", \"Partial-Mirror-mode-1LM\", \"Mirror-Mode-1LM\", \"Mirroring\", \"Lockstep\", \"Sparing\", \"Platform-Default\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bios.TokenSettings.List": { "title": "List of 'bios.TokenSettings' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.TokenSettings' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.TokenSettings' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.TokenSettings" }, "nullable": true } } } ] }, "bios.Unit.Response": { "description": "The response body of a HTTP GET request for the 'bios.Unit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.Unit' resources.", "x-one-of-name": "bios.Unit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.Unit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.Unit.Relationship": { "description": "A relationship to the 'bios.Unit' resource, or the expanded 'bios.Unit' resource, or the 'null' value.", "x-one-of-name": "bios.Unit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.Unit" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.Unit": { "title": "Bios:Unit", "description": "The bios.Unit object represents the BIOS (Basic Input/Output System) of a server. It acts as a container for BIOS-related inventory and configuration objects, such as the running firmware version and the system boot order.\n#### Purpose\nThe primary purpose of the bios.Unit object is to serve as a central anchor point for all BIOS-related information within the server's inventory. It aggregates critical components of the BIOS configuration, making them accessible for monitoring and management.\n#### Key Concepts\n- **Central BIOS Anchor:** Provides a single, identifiable object representing the server's BIOS.\n- **Firmware Tracking:** Links to firmware.RunningFirmware objects to provide the current, detailed version of the BIOS firmware.\n- **Boot Order Management:** Contains the bios.SystemBootOrder object, which details the actual boot sequence of the server as configured in the BIOS.\n- **Hierarchical Inventory:** Exists within the context of a compute.Blade or compute.RackUnit, tying the BIOS information directly to the physical server.", "x-allOf-name": "bios.Unit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.Unit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.Unit" ], "default": "bios.Unit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.Unit" ], "default": "bios.Unit", "x-enum-as-string": true }, "InitSeq": { "description": "The initSeq of the equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "InitTs": { "description": "The initTs of the equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "SystemBootOrder": { "$ref": "#/components/schemas/bios.SystemBootOrder.Relationship", "description": "A reference to a biosSystemBootOrder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "bios.Unit.List": { "title": "List of 'bios.Unit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.Unit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.Unit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.Unit" }, "nullable": true } } } ] }, "bios.VfSelectMemoryRasConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'bios.VfSelectMemoryRasConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'bios.VfSelectMemoryRasConfiguration' resources.", "x-one-of-name": "bios.VfSelectMemoryRasConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "bios.VfSelectMemoryRasConfiguration.Relationship": { "description": "A relationship to the 'bios.VfSelectMemoryRasConfiguration' resource, or the expanded 'bios.VfSelectMemoryRasConfiguration' resource, or the 'null' value.", "x-one-of-name": "bios.VfSelectMemoryRasConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "bios.VfSelectMemoryRasConfiguration": { "title": "Bios:Vf Select Memory Ras Configuration", "description": "The bios.VfSelectMemoryRasConfiguration object represents the currently active Memory Reliability, Availability, and Serviceability (RAS) configuration as reported by the server's BIOS.\n#### Purpose\nThis object serves as a read-only inventory point for the server's memory RAS mode. It allows administrators and automation tools to quickly identify the active memory configuration, such as \"maximum performance\", \"mirroring\", or \"sparing\" . It is critical for validating that the server's memory is configured for the desired level of performance and resilience.\n#### Key Concepts\n- **Active State Reporting:** The vpSelectMemoryRasConfiguration property provides the single, currently active memory RAS mode from a list of possible values.\n- **Configuration Verification:** Enables a direct check of the applied memory settings against a desired policy, ensuring the server is operating as expected.\n- **Read-Only Inventory:** Provides a factual snapshot of the BIOS-reported state, distinct from policy objects that define a target configuration.\n- **Server-Specific:** Directly associated with a physical server, ensuring the memory RAS information is tied to the correct hardware.", "x-allOf-name": "bios.VfSelectMemoryRasConfiguration", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'bios.VfSelectMemoryRasConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "bios.VfSelectMemoryRasConfiguration" ], "default": "bios.VfSelectMemoryRasConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "bios.VfSelectMemoryRasConfiguration" ], "default": "bios.VfSelectMemoryRasConfiguration", "x-enum-as-string": true }, "Serial": { "description": "Parent server serial number.", "type": "string", "x-omitempty": true }, "VpSelectMemoryRasConfiguration": { "description": "The actual BIOS memory RAS configuration as reported by the platform BIOS. Possible values are \"maximum-performance\", \"mirror-mode-1lm\", \"adddc-sparing\", \"platform-default\", \"lockstep\", \"sparing\", \"mirroring\".", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "bios.VfSelectMemoryRasConfiguration.List": { "title": "List of 'bios.VfSelectMemoryRasConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'bios.VfSelectMemoryRasConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'bios.VfSelectMemoryRasConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration" }, "nullable": true } } } ] }, "boot.Bootloader": { "title": "Boot:Bootloader", "description": "The boot loader is a program that loads the operating system when the computer is powered on.\n#### Purpose\nBootLoader defines common properties of a boot loader like bootloader path, which can be used by all boot devices. Other properties can be defined in individual boot device objects.\n#### Key Concepts\n- **Boot Loader Definition:** Captures common boot loader attributes, such as the loader name and path, used across multiple boot device types.\n- **Shared Structure:** Provides a reusable configuration framework that standardizes boot loader properties for all boot devices.", "x-allOf-name": "boot.Bootloader", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Bootloader', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Bootloader" ], "default": "boot.Bootloader", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Bootloader" ], "default": "boot.Bootloader", "x-enum-as-string": true }, "Description": { "description": "Carries more information about the bootloader.", "type": "string", "maxLength": 128, "x-omitempty": true }, "Name": { "description": "Name of the bootloader image.", "type": "string", "maxLength": 128, "x-omitempty": true }, "Path": { "description": "Path to the bootloader image.", "type": "string", "maxLength": 256, "x-omitempty": true } } } ] }, "boot.CddDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.CddDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.CddDevice' resources.", "x-one-of-name": "boot.CddDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.CddDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.CddDevice.Relationship": { "description": "A relationship to the 'boot.CddDevice' resource, or the expanded 'boot.CddDevice' resource, or the 'null' value.", "x-one-of-name": "boot.CddDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.CddDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.CddDevice": { "title": "Boot:Cdd Device", "description": "The boot.CddDevice object represents a CD/DVD drive as a configurable boot option within a server's boot policy.\n#### Purpose\nThe CddDevice object allows for the inclusion of a physical CD/DVD drive in a server's boot order. This provides a standardized way to define the CDD as a bootable source, including its name, order, and enabled state, within a boot policy.\n#### Key Concepts\n- **Bootable Source:** Defines a physical CD/DVD drive as a potential boot device.\n- **Configurable Order:** The order property allows its position in the boot sequence to be precisely controlled relative to other devices.\n- **State Management:** The state property (\"Enabled\" or \"Disabled\") allows the device to be included in a policy but toggled on or off without removing it.\n- **Policy Component:** Functions as a building block within a larger boot policy, associated with a compute.Physical server object.", "x-allOf-name": "boot.CddDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.CddDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.CddDevice" ], "default": "boot.CddDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.CddDevice" ], "default": "boot.CddDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.CddDevice.List": { "title": "List of 'boot.CddDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.CddDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.CddDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.CddDevice" }, "nullable": true } } } ] }, "boot.ConfiguredDevice": { "title": "Boot:Configured Device", "description": "Abstract class for all configured boot devices.", "x-allOf-name": "boot.ConfiguredDevice", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.ConfiguredDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice" ], "x-enum-as-string": true }, "Name": { "description": "The name of the boot device configured in the boot policy.", "type": "string", "x-omitempty": true }, "Order": { "description": "The order of the boot device configured in the boot policy.", "type": "integer", "format": "int64", "x-omitempty": true }, "State": { "description": "The state of the boot device configured in the boot policy.", "type": "string", "x-omitempty": true }, "Type": { "description": "The type of the boot device configured in the boot policy.", "type": "string", "x-omitempty": true } } } ] }, "boot.DeviceBase": { "title": "Boot:Device Base", "description": "Lists properties that are common to all device types. It serves as base class for other device types.", "x-allOf-name": "boot.DeviceBase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.DeviceBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "boot.FlexMmc", "boot.Http", "boot.Iscsi", "boot.LocalCdd", "boot.LocalDisk", "boot.Nvme", "boot.PchStorage", "boot.Pxe", "boot.San", "boot.SdCard", "boot.UefiShell", "boot.Usb", "boot.VirtualMedia" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "boot.FlexMmc", "boot.Http", "boot.Iscsi", "boot.LocalCdd", "boot.LocalDisk", "boot.Nvme", "boot.PchStorage", "boot.Pxe", "boot.San", "boot.SdCard", "boot.UefiShell", "boot.Usb", "boot.VirtualMedia" ], "x-enum-as-string": true }, "Enabled": { "description": "Specifies if the boot device is enabled or disabled.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "A name that helps identify a boot device. It can be any string that adheres to the following constraints. It should start and end with an alphanumeric character. It can have underscores and hyphens. It cannot be more than 30 characters. It cannot be a reserved keyword. However, it can be used in conjunction with other letters, numbers, underscores, and hyphens (EU_CDROM-3, etc.). Reserved words include - all, ALL, CDROM, EFI, EOD, FDD, HDD, HDDANY, HTTP, ISCSI, ISCSIANY, LOCALCDD, LOCALHDD, NULL, NVME, NVMEANY, PCHSTORAGE, PCHSTORANY, PXE, SAN, SANANY, SDANY, SDCARD, UEFISHELL, USB, USBCD, USBFDD, USBHDD, VMCIMCCD, VMCIMCHDD, VMEDIA, VMFDD, VMKVMCD, VMKVMHDD.", "type": "string", "pattern": "((^[a-zA-Z0-9]$){1,30}|(^(([a-zA-Z0-9])([a-zA-Z0-9_\\-]{0,28})([a-zA-Z0-9]))$))", "x-omitempty": true } } } ] }, "boot.DeviceBootMode.Response": { "description": "The response body of a HTTP GET request for the 'boot.DeviceBootMode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.DeviceBootMode' resources.", "x-one-of-name": "boot.DeviceBootMode.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.DeviceBootMode.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.DeviceBootMode.Relationship": { "description": "A relationship to the 'boot.DeviceBootMode' resource, or the expanded 'boot.DeviceBootMode' resource, or the 'null' value.", "x-one-of-name": "boot.DeviceBootMode.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.DeviceBootMode" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.DeviceBootMode": { "title": "Boot:Device Boot Mode", "description": "The boot.DeviceBootMode object represents the user-configured BIOS boot mode for a server, as defined in its boot policy. It reflects the intended state that should be applied to the server's BIOS.\n#### Purpose\nThe primary purpose of this object is to inventory the desired boot mode (e.g., \"Legacy\" or \"Uefi\") from a server's configuration policy. This allows for a clear distinction and comparison between the intended configuration (configuredBootMode) and the actual, running state of the server, which is reported by the BIOS.BootMode object.\n#### Key Concepts\n- **Desired State Representation:** Captures the configuredBootMode from a boot policy, representing what the boot mode should be.\n- **Policy Verification:** Facilitates auditing and compliance checks by allowing a direct comparison between the configured and actual boot modes.\n- **Configuration-Centric:** Unlike BIOS.BootMode, which reports the hardware's state, this object reflects the state defined in a management policy.\n- **Server Association:** Directly linked to a compute.Physical object, ensuring the configured boot mode is tied to a specific server.", "x-allOf-name": "boot.DeviceBootMode", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.DeviceBootMode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.DeviceBootMode" ], "default": "boot.DeviceBootMode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.DeviceBootMode" ], "default": "boot.DeviceBootMode", "x-enum-as-string": true }, "ConfiguredBootMode": { "description": "The user desired BIOS boot mode as configured in the boot policy.", "type": "string", "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.DeviceBootMode.List": { "title": "List of 'boot.DeviceBootMode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.DeviceBootMode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.DeviceBootMode' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.DeviceBootMode" }, "nullable": true } } } ] }, "boot.DeviceBootSecurity.Response": { "description": "The response body of a HTTP GET request for the 'boot.DeviceBootSecurity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.DeviceBootSecurity' resources.", "x-one-of-name": "boot.DeviceBootSecurity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.DeviceBootSecurity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.DeviceBootSecurity.Relationship": { "description": "A relationship to the 'boot.DeviceBootSecurity' resource, or the expanded 'boot.DeviceBootSecurity' resource, or the 'null' value.", "x-one-of-name": "boot.DeviceBootSecurity.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.DeviceBootSecurity" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.DeviceBootSecurity": { "title": "Boot:Device Boot Security", "description": "The boot.DeviceBootSecurity object represents the user-configured state of UEFI Secure Boot for a server, as defined in its boot policy.\n#### Purpose\nThis object's main function is to inventory the desired state of Secure Boot (\"Enabled\" or \"Disabled\") from a server's applied policy. This provides a clear record of the intended security posture for the server's boot process. This allows for auditing and verification against the actual Secure Boot state reported by the BIOS.\n#### Key Concepts\n- **Desired Security State:** The secureBoot property captures the intended configuration from a boot policy.\n- **Compliance and Auditing:** Enables administrators to verify that servers are compliant with security policies requiring Secure Boot to be enabled.\n- **Configuration-Centric View:** Reflects the policy-defined setting, which can be compared against the actual hardware state for consistency.\n- **Server-Specific:** Associated with a compute.Physical object, linking the configured Secure Boot state to a specific server.", "x-allOf-name": "boot.DeviceBootSecurity", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.DeviceBootSecurity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.DeviceBootSecurity" ], "default": "boot.DeviceBootSecurity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.DeviceBootSecurity" ], "default": "boot.DeviceBootSecurity", "x-enum-as-string": true }, "SecureBoot": { "description": "The user desired BIOS secure boot as configured in the boot policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.DeviceBootSecurity.List": { "title": "List of 'boot.DeviceBootSecurity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.DeviceBootSecurity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.DeviceBootSecurity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.DeviceBootSecurity" }, "nullable": true } } } ] }, "boot.FlexMmc": { "title": "FlexMMC", "description": "Device type used when booting from FlexMMC device.", "x-allOf-name": "boot.FlexMmc", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.FlexMmc', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.FlexMmc" ], "default": "boot.FlexMmc", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.FlexMmc" ], "default": "boot.FlexMmc", "x-enum-as-string": true }, "Subtype": { "description": "The subtype for the selected device type.\n* `None` - No sub type for FlexMMC boot device.\n* `flexmmc-mapped-dvd` - Use of FlexMMC DVD as subtype for embedded storage.\n* `flexmmc-mapped-hdd` - Use of FlexMMC HDD as subtype for embedded storage.", "type": "string", "enum": [ "None", "flexmmc-mapped-dvd", "flexmmc-mapped-hdd" ], "default": "None", "x-omitempty": true } } } ] }, "boot.HddDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.HddDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.HddDevice' resources.", "x-one-of-name": "boot.HddDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.HddDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.HddDevice.Relationship": { "description": "A relationship to the 'boot.HddDevice' resource, or the expanded 'boot.HddDevice' resource, or the 'null' value.", "x-one-of-name": "boot.HddDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.HddDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.HddDevice": { "title": "Boot:Hdd Device", "description": "The boot.HddDevice object represents a local hard disk drive (HDD) or logical volume as a configurable boot option within a server's boot policy.\n#### Purpose\nThe HddDevice object provides a standardized way to specify a local disk as a bootable device in a server's boot sequence. It allows administrators to define the disk's position in the boot order and its enabled state within a managed boot policy.\n#### Key Concepts\n- **Local Disk Boot:** Defines a local HDD or RAID volume as a bootable source.\n- **Ordered Boot Sequence:** The order property determines its priority in the boot process relative to other configured devices like PXE, SAN, or USB.\n- **Enable/Disable Control:** The state property allows the HDD to be included in a policy but easily enabled or disabled as a boot option.\n- **Boot Policy Element:** Acts as a fundamental component within a boot policy that is applied to a compute.Physical server object.", "x-allOf-name": "boot.HddDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.HddDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.HddDevice" ], "default": "boot.HddDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.HddDevice" ], "default": "boot.HddDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.HddDevice.List": { "title": "List of 'boot.HddDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.HddDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.HddDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.HddDevice" }, "nullable": true } } } ] }, "boot.Http": { "title": "HTTP Boot", "description": "Device type used in boot policy to boot from HTTP device.", "x-allOf-name": "boot.Http", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Http', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Http" ], "default": "boot.Http", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Http" ], "default": "boot.Http", "x-enum-as-string": true }, "InterfaceName": { "description": "For integrated NICs, specify the underlying network interface card name (such as 1 or 2). For virtual NICs, specify the vNIC name (customized name like eth0).", "type": "string", "pattern": "^[a-zA-Z0-9-._:]*$", "x-omitempty": true }, "InterfaceSource": { "description": "Lists the supported Interface Source for HTTP device. Supported values are \"name\" and \"mac\".\n* `name` - Use interface name to select virtual ethernet interface.\n* `mac` - Use MAC address to select virtual ethernet interface.\n* `port` - Use port to select virtual ethernet interface.", "type": "string", "enum": [ "name", "mac", "port" ], "default": "name", "x-omitempty": true }, "IpConfigType": { "description": "The IP config type to use during the HTTP boot process. For DHCP configuration, the IP address, DNS server, netmask and gateway details are obtained from DHCP server. For static configuration, please provide the IP address, DNS server, netmask, and gateway details.\n* `DHCP` - The type of the IP config is DHCP.\n* `Static` - The type of the IP config is Static.", "type": "string", "enum": [ "DHCP", "Static" ], "default": "DHCP", "x-omitempty": true }, "IpType": { "description": "The IP address family type to use during the HTTP boot process.\n* `IPv4` - The type of the IP address is IPv4.\n* `IPv6` - The type of the IP address is IPv6.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-omitempty": true }, "MacAddress": { "description": "The MAC Address of the underlying virtual ethernet interface used by the HTTP boot device.", "type": "string", "pattern": "^$|^(((\\d|([a-f]|[A-F])){2}:){5}(\\d|([a-f]|[A-F])){2})$", "x-omitempty": true }, "Port": { "description": "Enter the port ID of the adapter for the virtual ethernet interface. Valid values are 0 to 255.", "type": "integer", "format": "int64", "default": -1, "minimum": -1, "maximum": 255, "x-omitempty": true }, "Protocol": { "description": "Protocol to be used for HTTP boot. HTTPS require root certificate for authentication.\n* `HTTPS` - Secure HTTP protocol, certificate required for authentication.\n* `HTTP` - HTTP protocol without security certificate requirement.", "type": "string", "enum": [ "HTTPS", "HTTP" ], "default": "HTTPS", "x-omitempty": true }, "Slot": { "description": "The slot ID of the adapter on which the underlying virtual ethernet interface is present. Supported values are ( 1 - 255, \"MLOM\", \"L\", \"L1\", \"L2\", \"OCP\").", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$", "x-omitempty": true }, "StaticIpV4Settings": { "description": "The static IP config settings to use during the HTTP boot process.", "$ref": "#/components/schemas/boot.StaticIpV4Settings", "x-omitempty": true }, "StaticIpV6Settings": { "description": "The static IP config settings to use during the HTTP boot process.", "$ref": "#/components/schemas/boot.StaticIpV6Settings", "x-omitempty": true }, "Uri": { "description": "Boot resource location in URI format.", "type": "string", "pattern": "^$|^[hH][tT][tT][pP][sS]?://[^\\s/$.?#].[^\\s]*$", "x-omitempty": true } } } ] }, "boot.Iscsi": { "title": "iSCSI Boot", "description": "Device type used when booting from iSCSI boot device.", "x-allOf-name": "boot.Iscsi", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Iscsi', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Iscsi" ], "default": "boot.Iscsi", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Iscsi" ], "default": "boot.Iscsi", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during iSCSI boot.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true }, "InterfaceName": { "description": "The name of the underlying virtual ethernet interface used by the iSCSI boot device.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]*$", "x-omitempty": true }, "InterfaceSource": { "description": "Lists the supported methods to provide network boot device configuration. Supported values are \"name\" and \"port\".\n* `name` - Use interface name to select virtual ethernet interface.\n* `mac` - Use MAC address to select virtual ethernet interface.\n* `port` - Use port to select virtual ethernet interface.", "type": "string", "enum": [ "name", "mac", "port" ], "default": "name", "x-omitempty": true }, "Port": { "description": "Port ID of the ISCSI boot device.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "Slot": { "description": "The slot id of the device. Supported values are (1 - 255, \"MLOM\", \"L\", \"L1\", \"L2\", \"OCP\").", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$", "x-omitempty": true } } } ] }, "boot.IscsiDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.IscsiDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.IscsiDevice' resources.", "x-one-of-name": "boot.IscsiDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.IscsiDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.IscsiDevice.Relationship": { "description": "A relationship to the 'boot.IscsiDevice' resource, or the expanded 'boot.IscsiDevice' resource, or the 'null' value.", "x-one-of-name": "boot.IscsiDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.IscsiDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.IscsiDevice": { "title": "Boot:Iscsi Device", "description": "The boot.IscsiDevice object represents an iSCSI LUN (Logical Unit Number) as a configurable boot option within a server's boot policy. It allows a server to boot from a remote storage target over an IP network.\n#### Purpose\nThe IscsiDevice object provides a standardized way to define an iSCSI target as a bootable source. It encapsulates the necessary parameters, such as the iSCSI initiator and target details, to establish a boot-from-iSCSI session. This enables diskless server configurations where the operating system resides on a centralized storage array.\n#### Key Concepts\n- **Network Boot:** Defines a remote iSCSI LUN as a primary or secondary boot device.\n- **Configurable Order:** The order property allows its position in the boot sequence to be set relative to other local or network boot devices.\n- **State Management:** The state property allows the iSCSI boot option to be enabled or disabled within a policy without removing the configuration.\n- **Boot Policy Component:** Functions as a key element within a boot policy, which is then associated with a compute.Physical server object.", "x-allOf-name": "boot.IscsiDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.IscsiDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.IscsiDevice" ], "default": "boot.IscsiDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.IscsiDevice" ], "default": "boot.IscsiDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.IscsiDevice.List": { "title": "List of 'boot.IscsiDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.IscsiDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.IscsiDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.IscsiDevice" }, "nullable": true } } } ] }, "boot.LocalCdd": { "title": "Local CDD", "description": "Device type used when booting from local CD drive.", "x-allOf-name": "boot.LocalCdd", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" } ] }, "boot.LocalDisk": { "title": "Local Disk", "description": "Device type used when booting from a local disk device.", "x-allOf-name": "boot.LocalDisk", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.LocalDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.LocalDisk" ], "default": "boot.LocalDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.LocalDisk" ], "default": "boot.LocalDisk", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during boot from local disk.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true }, "Slot": { "description": "The slot id of the local disk device. Supported values for Standalone Rack servers are (1-205, \"M\", \"HBA\", \"SAS\", \"RAID\", \"MRAID\", \"MRAID1\", \"MRAID2\", \"MSTOR-RAID\"). Supported values for FI-attached servers are (1-205, \"RAID\", \"MRAID\", \"FMEZZ1-SAS\", \"MRAID1\", \"MRAID2\", \"MSTOR-RAID\", \"MSTOR-RAID-1\", \"MSTOR-RAID-2\").", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|20[0-5]|M|HBA|SAS|MRAID|RAID|MRAID1|MRAID2|MSTOR-RAID|FMEZZ1-SAS|MSTOR-RAID-1|MSTOR-RAID-2|LOM-NIC-1)$", "x-omitempty": true } } } ] }, "boot.Nvme": { "title": "NVMe", "description": "Device type used when booting from a NVMe device.", "x-allOf-name": "boot.Nvme", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Nvme', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Nvme" ], "default": "boot.Nvme", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Nvme" ], "default": "boot.Nvme", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during NVME boot.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true } } } ] }, "boot.NvmeDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.NvmeDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.NvmeDevice' resources.", "x-one-of-name": "boot.NvmeDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.NvmeDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.NvmeDevice.Relationship": { "description": "A relationship to the 'boot.NvmeDevice' resource, or the expanded 'boot.NvmeDevice' resource, or the 'null' value.", "x-one-of-name": "boot.NvmeDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.NvmeDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.NvmeDevice": { "title": "Boot:Nvme Device", "description": "The boot.NvmeDevice object represents an NVMe (Non-Volatile Memory Express) drive as a configurable boot option within a server's boot policy.\n#### Purpose\nThe NvmeDevice object is used to specify a local NVMe drive as a bootable device in a server's boot sequence. This provides a standardized method for including high-performance NVMe storage in the boot order, allowing administrators to define its priority and state within a boot policy.\n#### Key Concepts\n- **High-Performance Boot:** Defines a local NVMe SSD as a bootable source, leveraging its high speed for faster OS startup.\n- **Ordered Boot Sequence:** The order property allows its position in the boot process to be precisely controlled relative to other devices.\n- **Enable/Disable Control:** The state property allows the NVMe drive to be easily enabled or disabled as a boot option within a policy.\n- **Boot Policy Element:** Acts as a component within a boot policy that is applied to a compute.Physical server object.", "x-allOf-name": "boot.NvmeDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.NvmeDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.NvmeDevice" ], "default": "boot.NvmeDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.NvmeDevice" ], "default": "boot.NvmeDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.NvmeDevice.List": { "title": "List of 'boot.NvmeDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.NvmeDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.NvmeDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.NvmeDevice" }, "nullable": true } } } ] }, "boot.PchStorage": { "title": "PCH Storage", "description": "Device type used when booting from a PCH Storage device.", "x-allOf-name": "boot.PchStorage", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.PchStorage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.PchStorage" ], "default": "boot.PchStorage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.PchStorage" ], "default": "boot.PchStorage", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during PCH Storage boot.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true }, "Lun": { "description": "The Logical Unit Number (LUN) of the device. It is the Virtual Drive number for Cisco UCS C-Series Servers. Virtual Drive number is found in storage inventory.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true } } } ] }, "boot.PchStorageDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.PchStorageDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.PchStorageDevice' resources.", "x-one-of-name": "boot.PchStorageDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.PchStorageDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.PchStorageDevice.Relationship": { "description": "A relationship to the 'boot.PchStorageDevice' resource, or the expanded 'boot.PchStorageDevice' resource, or the 'null' value.", "x-one-of-name": "boot.PchStorageDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.PchStorageDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.PchStorageDevice": { "title": "Boot:Pch Storage Device", "description": "The boot.PchStorageDevice object represents a storage device connected to the Platform Controller Hub (PCH) as a configurable boot option within a server's boot policy. This typically refers to onboard SATA or M.2 devices managed by the chipset.\n#### Purpose\nThe PchStorageDevice object provides a standardized way to include PCH-attached storage, such as an M.2 SATA drive, in a server's boot order. It allows administrators to define the device's boot priority and enabled state within a managed boot policy.\n#### Key Concepts\n- **Onboard Storage Boot:** Defines a device connected directly to the motherboard's PCH as a bootable source.\n- **Configurable Priority:** The order property determines its position in the boot sequence relative to other devices like RAID controllers or PCIe drives.\n- **State Management:** The state property allows the PCH storage device to be enabled or disabled as a boot option within a policy.\n- **Boot Policy Component:** Functions as an element within a boot policy that is associated with a compute.Physical server object.", "x-allOf-name": "boot.PchStorageDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.PchStorageDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.PchStorageDevice" ], "default": "boot.PchStorageDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.PchStorageDevice" ], "default": "boot.PchStorageDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.PchStorageDevice.List": { "title": "List of 'boot.PchStorageDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.PchStorageDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.PchStorageDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.PchStorageDevice" }, "nullable": true } } } ] }, "boot.PrecisionPolicy.Response": { "description": "The response body of a HTTP GET request for the 'boot.PrecisionPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.PrecisionPolicy' resources.", "x-one-of-name": "boot.PrecisionPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.PrecisionPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.PrecisionPolicy": { "title": "Boot Order", "description": "The Boot PrecisionPolicy object is a reusable policy that defines a precise and ordered list of bootable devices for a server. It supports both UEFI and Legacy boot modes and provides granular control over the boot sequence.\n#### Purpose\nThe primary purpose of this policy is to automate and enforce a specific boot order on servers. It is critical for ensuring that servers boot from the correct media, whether it is a local disk, a SAN LUN, a PXE server, or a virtual media device. By using a policy, administrators can guarantee consistent boot behavior for servers assigned to a Server Profile.\n#### Key Concepts\n- **UEFI and Legacy Support:** The policy allows administrators to specify the desired boot mode (Uefi or Legacy) and whether to enforce UEFI Secure Boot.\n- **Ordered Device List:** It contains an ordered list of boot devices, where each entry specifies the device type (e.g., LocalDisk, Pxe, San, Nvme) and its specific configuration.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the defined boot order to a physical server.\n- **Reboot Required:** Changes to the boot order policy are flagged with ActivationRequiresReboot, as a server reboot is necessary to apply the new boot sequence.\n- **Dependent on Connectivity Policies:** The policy's effectiveness can depend on other policies, such as LAN and SAN connectivity policies, which configure the network interfaces used for PXE or SAN booting.", "x-allOf-name": "boot.PrecisionPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.PrecisionPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.PrecisionPolicy" ], "default": "boot.PrecisionPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.PrecisionPolicy" ], "default": "boot.PrecisionPolicy", "x-enum-as-string": true }, "BootDevices": { "type": "array", "items": { "description": "Set of boot devices to be configured.", "$ref": "#/components/schemas/boot.DeviceBase", "x-omitempty": true }, "minItems": 0, "maxItems": 255, "nullable": true }, "ConfiguredBootMode": { "description": "Sets the BIOS boot mode. UEFI uses the GUID Partition Table (GPT) whereas Legacy mode uses the MBR partitioning scheme. Unified Edge servers support only UEFI boot mode. Legacy mode is not supported on these platforms. To apply this setting, Please reboot the server.\n* `Uefi` - UEFI mode uses the GUID Partition Table (GPT) to locate EFI Service Partitions to boot from.\n* `Legacy` - Legacy mode refers to the traditional process of booting from BIOS. Legacy mode uses the MBR to locate the bootloader. Not supported on Unified Edge Server.", "type": "string", "enum": [ "Uefi", "Legacy" ], "default": "Uefi", "x-omitempty": true }, "EnableBootMigrationSupport": { "description": "Flag to denote if migration is enabled for the boot devices.", "type": "boolean", "x-omitempty": true }, "EnforceUefiSecureBoot": { "description": "If UEFI secure boot is enabled, the boot mode is set to UEFI by default. Secure boot enforces that device boots using only software that is trusted by the Original Equipment Manufacturer (OEM).", "type": "boolean", "default": false, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "boot.PrecisionPolicy.List": { "title": "List of 'boot.PrecisionPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.PrecisionPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.PrecisionPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.PrecisionPolicy" }, "nullable": true } } } ] }, "boot.Pxe": { "title": "PXE Boot", "description": "Device type used when booting from a PXE boot device.", "x-allOf-name": "boot.Pxe", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Pxe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Pxe" ], "default": "boot.Pxe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Pxe" ], "default": "boot.Pxe", "x-enum-as-string": true }, "InterfaceName": { "description": "For integrated NICs, specify the underlying network interface card name (such as 1 or 2). For virtual NICs, specify the vNIC name (customized name like eth0).", "type": "string", "pattern": "^[a-zA-Z0-9-._:]*$", "x-omitempty": true }, "InterfaceSource": { "description": "Lists the supported methods to provide network boot device configuration. Supported values are \"name\" and \"mac\".\n* `name` - Use interface name to select virtual ethernet interface.\n* `mac` - Use MAC address to select virtual ethernet interface.\n* `port` - Use port to select virtual ethernet interface.", "type": "string", "enum": [ "name", "mac", "port" ], "default": "name", "x-omitempty": true }, "IpType": { "description": "The IP Address family type to use during the PXE Boot process.\n* `None` - Default value if IpType is not specified.\n* `IPv4` - The IPv4 address family type.\n* `IPv6` - The IPv6 address family type.", "type": "string", "enum": [ "None", "IPv4", "IPv6" ], "default": "None", "x-omitempty": true }, "MacAddress": { "description": "The MAC Address of the underlying virtual ethernet interface used by the PXE boot device.", "type": "string", "pattern": "^$|^(((\\d|([a-f]|[A-F])){2}:){5}(\\d|([a-f]|[A-F])){2})$", "x-omitempty": true }, "Port": { "description": "Enter the port ID of the adapter for the virtual ethernet interface. Valid values are 0 to 255.", "type": "integer", "format": "int64", "default": -1, "minimum": -1, "maximum": 255, "x-omitempty": true }, "Slot": { "description": "The slot ID of the adapter on which the underlying virtual ethernet interface is present. Supported values are ( 1 - 255, \"MLOM\", \"L\", \"L1\", \"L2\", \"OCP\").", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|L|MLOM|L1|L2|OCP)$", "x-omitempty": true } } } ] }, "boot.PxeDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.PxeDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.PxeDevice' resources.", "x-one-of-name": "boot.PxeDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.PxeDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.PxeDevice.Relationship": { "description": "A relationship to the 'boot.PxeDevice' resource, or the expanded 'boot.PxeDevice' resource, or the 'null' value.", "x-one-of-name": "boot.PxeDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.PxeDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.PxeDevice": { "title": "Boot:Pxe Device", "description": "The boot.PxeDevice object represents a Preboot Execution Environment (PXE) network interface as a configurable boot option within a server's boot policy.\n#### Purpose\nThe PxeDevice object is used to define a network-based boot process using PXE. It allows a server to boot by loading an operating system image from a network server, which is essential for automated provisioning and diskless client setups. The object specifies which network interface to use and its priority in the boot sequence.\n#### Key Concepts\n- **Network-Based Boot:** Defines a network interface as a bootable source using the PXE protocol.\n- **Ordered Boot Sequence:** The order property allows its position to be set relative to other boot options like local disks or SAN LUNs.\n- **Interface Selection:** Can be configured to use a specific network interface for the PXE boot attempt.\n- **Boot Policy Element:** Acts as a fundamental component within a boot policy that is applied to a compute.Physical server object.", "x-allOf-name": "boot.PxeDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.PxeDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.PxeDevice" ], "default": "boot.PxeDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.PxeDevice" ], "default": "boot.PxeDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.PxeDevice.List": { "title": "List of 'boot.PxeDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.PxeDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.PxeDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.PxeDevice" }, "nullable": true } } } ] }, "boot.San": { "title": "SAN Boot", "description": "Device type used when booting from SAN Boot device.", "x-allOf-name": "boot.San", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.San', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.San" ], "default": "boot.San", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.San" ], "default": "boot.San", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during SAN boot.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true }, "InterfaceName": { "description": "The name of the underlying vHBA interface to be used by the SAN boot device.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]*$", "x-omitempty": true }, "Lun": { "description": "The Logical Unit Number (LUN) of the device. For SAN boot configuration to be deployed on a server with 1300 family of Cisco VIC adapters, the recommendation is for the boot LUN to be numbered as 0 to ensure that LUN is mounted as the first disk from which the server boots.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "Slot": { "description": "Slot ID of the device. Supported values are ( 1 - 255, \"MLOM\", \"L1\", \"L2\" ).", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]|MLOM|L1|L2)$", "x-omitempty": true }, "Wwpn": { "description": "The WWPN Address of the underlying fibre channel interface used by the SAN boot device. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.", "type": "string", "pattern": "^$|(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "x-omitempty": true } } } ] }, "boot.SanDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.SanDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.SanDevice' resources.", "x-one-of-name": "boot.SanDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.SanDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.SanDevice.Relationship": { "description": "A relationship to the 'boot.SanDevice' resource, or the expanded 'boot.SanDevice' resource, or the 'null' value.", "x-one-of-name": "boot.SanDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.SanDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.SanDevice": { "title": "Boot:San Device", "description": "The boot.SanDevice object represents a Storage Area Network (SAN) LUN (Logical Unit Number) as a configurable boot option within a server's boot policy.\n#### Purpose\nThe SanDevice object is used to enable a \"boot from SAN\" configuration, where a server's operating system resides on a LUN provided by a remote Fibre Channel storage array. It allows administrators to specify the SAN target (via its WWN) and its priority in the boot sequence, facilitating centralized storage management and diskless server deployments.\n#### Key Concepts\n- **Boot From SAN:** Defines a remote Fibre Channel LUN as a bootable source.\n- **Target Identification:** Specifies the target LUN to boot from, typically using its World Wide Name (WWN).\n- **Configurable Priority:** The order property determines its position in the boot sequence relative to other local or network devices.\n- **Boot Policy Component:** Functions as a key element within a boot policy that is associated with a compute.Physical server object.", "x-allOf-name": "boot.SanDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.SanDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.SanDevice" ], "default": "boot.SanDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.SanDevice" ], "default": "boot.SanDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.SanDevice.List": { "title": "List of 'boot.SanDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.SanDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.SanDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.SanDevice" }, "nullable": true } } } ] }, "boot.SdCard": { "title": "SD Card", "description": "Device type used when booting from SD Card device.", "x-allOf-name": "boot.SdCard", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.SdCard', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.SdCard" ], "default": "boot.SdCard", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.SdCard" ], "default": "boot.SdCard", "x-enum-as-string": true }, "Bootloader": { "description": "Details of the bootloader to be used during SD card boot.", "$ref": "#/components/schemas/boot.Bootloader", "x-omitempty": true }, "Lun": { "description": "The Logical Unit Number (LUN) of the device.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "Subtype": { "description": "The subtype for the selected device type.\n* `None` - No sub type for SD card boot device.\n* `flex-util` - Use of FlexUtil (microSD) card as sub type for SD card boot device.\n* `flex-flash` - Use of FlexFlash (SD) card as sub type for SD card boot device.\n* `SDCARD` - Use of SD card as sub type for the SD Card boot device.", "type": "string", "enum": [ "None", "flex-util", "flex-flash", "SDCARD" ], "default": "None", "x-omitempty": true } } } ] }, "boot.SdDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.SdDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.SdDevice' resources.", "x-one-of-name": "boot.SdDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.SdDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.SdDevice.Relationship": { "description": "A relationship to the 'boot.SdDevice' resource, or the expanded 'boot.SdDevice' resource, or the 'null' value.", "x-one-of-name": "boot.SdDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.SdDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.SdDevice": { "title": "Boot:Sd Device", "description": "The boot.SdDevice object represents an SD (Secure Digital) card as a configurable boot option within a server's boot policy. This typically refers to an internal SD card slot, often used for booting hypervisors.\n#### Purpose\nThe SdDevice object provides a standardized way to include an SD card in a server's boot order. It allows administrators to define the SD card as a bootable source, set its priority, and manage its state (enabled/disabled) within a boot policy. It is particularly useful for embedded operating systems or hypervisor installations.\n#### Key Concepts\n- **Embedded OS Boot:** Defines an internal SD card as a bootable source, commonly used for lightweight hypervisors like VMware ESXi. \n- **Ordered Boot Sequence:** The order property allows its position in the boot process to be controlled relative to other devices.\n- **State Management:** The state property allows the SD card to be easily enabled or disabled as a boot option within a policy.\n- **Boot Policy Component:** Acts as an element within a boot policy that is applied to a compute.Physical server object.", "x-allOf-name": "boot.SdDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.SdDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.SdDevice" ], "default": "boot.SdDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.SdDevice" ], "default": "boot.SdDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.SdDevice.List": { "title": "List of 'boot.SdDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.SdDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.SdDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.SdDevice" }, "nullable": true } } } ] }, "boot.StaticIpV4Settings": { "title": "Boot:Static Ip V4 Settings", "description": "Lists the properties that can be used for static IPv4 configuration in HTTP boot.", "x-allOf-name": "boot.StaticIpV4Settings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.StaticIpV4Settings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.StaticIpV4Settings" ], "default": "boot.StaticIpV4Settings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.StaticIpV4Settings" ], "default": "boot.StaticIpV4Settings", "x-enum-as-string": true }, "DnsIp": { "description": "IP address of DNS server.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "GatewayIp": { "description": "IP address of default gateway.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "Ip": { "description": "Ipv4 static Internet Protocol address.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "NetworkMask": { "description": "Network mask of the IP address.", "type": "string", "pattern": "^$|^(((255\\.){3}(255|254|252|248|240|224|192|128|0+))|((255\\.){2}(255|254|252|248|240|224|192|128|0+)\\.0)|((255\\.)(255|254|252|248|240|224|192|128|0+)(\\.0+){2})|((255|254|252|248|240|224|192|128|0+)(\\.0+){3}))$", "x-omitempty": true } } } ] }, "boot.StaticIpV6Settings": { "title": "Boot:Static Ip V6 Settings", "description": "Lists the properties that can be used for static IPv6 configuration in HTTP boot.", "x-allOf-name": "boot.StaticIpV6Settings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.StaticIpV6Settings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.StaticIpV6Settings" ], "default": "boot.StaticIpV6Settings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.StaticIpV6Settings" ], "default": "boot.StaticIpV6Settings", "x-enum-as-string": true }, "DnsIp": { "description": "IP address of DNS server.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "GatewayIp": { "description": "IP address of default gateway.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "Ip": { "description": "Ipv6 static Internet Protocol address.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "PrefixLength": { "description": "A prefix length which masks the IP address and divides the IP address into network address and host address.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 127, "x-omitempty": true } } } ] }, "boot.UefiShell": { "title": "UEFI Shell", "description": "Device type used when booting from UEFI shell.", "x-allOf-name": "boot.UefiShell", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" } ] }, "boot.UefiShellDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.UefiShellDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.UefiShellDevice' resources.", "x-one-of-name": "boot.UefiShellDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.UefiShellDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.UefiShellDevice.Relationship": { "description": "A relationship to the 'boot.UefiShellDevice' resource, or the expanded 'boot.UefiShellDevice' resource, or the 'null' value.", "x-one-of-name": "boot.UefiShellDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.UefiShellDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.UefiShellDevice": { "title": "Boot:Uefi Shell Device", "description": "The boot.UefiShellDevice object represents the UEFI (Unified Extensible Firmware Interface) Shell as a configurable boot option within a server's boot policy.\n#### Purpose\nThe UefiShellDevice object allows administrators to include the UEFI Shell as a target in the server's boot sequence. The UEFI Shell provides a command-line environment for scripting, diagnostics, and manually launching UEFI applications, which can be a valuable tool for advanced troubleshooting and system maintenance before an operating system loads.\n#### Key Concepts\n- **Diagnostic Environment:** Defines the built-in UEFI Shell as a bootable target.\n- **Configurable Priority:** The order property determines its position in the boot sequence, allowing it to be prioritized for maintenance tasks.\n- **Enable/Disable Control:** The state property allows the UEFI Shell to be easily enabled or disabled as a boot option within a policy.\n- **Boot Policy Element:** Functions as a component within a boot policy that is associated with a compute.Physical server object.", "x-allOf-name": "boot.UefiShellDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.UefiShellDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.UefiShellDevice" ], "default": "boot.UefiShellDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.UefiShellDevice" ], "default": "boot.UefiShellDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.UefiShellDevice.List": { "title": "List of 'boot.UefiShellDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.UefiShellDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.UefiShellDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.UefiShellDevice" }, "nullable": true } } } ] }, "boot.Usb": { "title": "USB", "description": "Device type used when booting from USB device.", "x-allOf-name": "boot.Usb", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.Usb', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.Usb" ], "default": "boot.Usb", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.Usb" ], "default": "boot.Usb", "x-enum-as-string": true }, "Subtype": { "description": "The subtype for the selected device type.\n* `None` - No sub type for USB boot device.\n* `usb-cd` - Use of Compact Disk (CD) as sub-type for the USB boot device.\n* `usb-fdd` - Use of Floppy Disk Drive (FDD) as sub-type for the USB boot device.\n* `usb-hdd` - Use of Hard Disk Drive (HDD) as sub-type for the USB boot device.", "type": "string", "enum": [ "None", "usb-cd", "usb-fdd", "usb-hdd" ], "default": "None", "x-omitempty": true } } } ] }, "boot.UsbDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.UsbDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.UsbDevice' resources.", "x-one-of-name": "boot.UsbDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.UsbDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.UsbDevice.Relationship": { "description": "A relationship to the 'boot.UsbDevice' resource, or the expanded 'boot.UsbDevice' resource, or the 'null' value.", "x-one-of-name": "boot.UsbDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.UsbDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.UsbDevice": { "title": "Boot:Usb Device", "description": "Usb Boot Device configured on the server.", "x-allOf-name": "boot.UsbDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.UsbDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.UsbDevice" ], "default": "boot.UsbDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.UsbDevice" ], "default": "boot.UsbDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.UsbDevice.List": { "title": "List of 'boot.UsbDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.UsbDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.UsbDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.UsbDevice" }, "nullable": true } } } ] }, "boot.VirtualMedia": { "title": "Virtual Media", "description": "Device type used when booting from Virtual Media device.", "x-allOf-name": "boot.VirtualMedia", "allOf": [ { "$ref": "#/components/schemas/boot.DeviceBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.VirtualMedia', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.VirtualMedia" ], "default": "boot.VirtualMedia", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.VirtualMedia" ], "default": "boot.VirtualMedia", "x-enum-as-string": true }, "Subtype": { "description": "The subtype for the selected device type.\n* `None` - No sub type for virtual media.\n* `cimc-mapped-dvd` - The virtual media device is mapped to a virtual DVD device.\n* `cimc-mapped-hdd` - The virtual media device is mapped to a virtual HDD device.\n* `kvm-mapped-dvd` - A KVM mapped DVD virtual media device.\n* `kvm-mapped-hdd` - A KVM mapped HDD virtual media device.\n* `kvm-mapped-fdd` - A KVM mapped FDD virtual media device.", "type": "string", "enum": [ "None", "cimc-mapped-dvd", "cimc-mapped-hdd", "kvm-mapped-dvd", "kvm-mapped-hdd", "kvm-mapped-fdd" ], "default": "None", "x-omitempty": true } } } ] }, "boot.VmediaDevice.Response": { "description": "The response body of a HTTP GET request for the 'boot.VmediaDevice' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'boot.VmediaDevice' resources.", "x-one-of-name": "boot.VmediaDevice.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/boot.VmediaDevice.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "boot.VmediaDevice.Relationship": { "description": "A relationship to the 'boot.VmediaDevice' resource, or the expanded 'boot.VmediaDevice' resource, or the 'null' value.", "x-one-of-name": "boot.VmediaDevice.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/boot.VmediaDevice" } ], "discriminator": { "propertyName": "ClassId" } }, "boot.VmediaDevice": { "title": "Boot:Vmedia Device", "description": "The boot.VmediaDevice object represents a virtual media device as a configurable boot option within a server's boot policy. Virtual media allows mounting of a remote image (like an ISO or IMG file) as if it were a local physical device (like a CD/DVD or USB drive).\n#### Purpose\nThe VmediaDevice object is used to enable booting from a remotely mounted image file. It is crucial for OS installation, recovery operations, and diagnostics without needing physical access to the server. It allows administrators to define virtual media as a boot source and set its priority within a boot policy.\n#### Key Concepts\n- **Remote Media Boot:** Defines a virtual CD/DVD or USB drive, sourced from a remote image file, as a bootable device.\n- **Flexible OS Installation:** Facilitates the installation of operating systems and software from ISO images without physical media.\n- **Ordered Boot Sequence:** The order property allows its position in the boot process to be controlled relative to other physical or network devices.\n- **Boot Policy Component:** Acts as a key element within a boot policy that is applied to a compute.Physical server object.", "x-allOf-name": "boot.VmediaDevice", "allOf": [ { "$ref": "#/components/schemas/boot.ConfiguredDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'boot.VmediaDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "boot.VmediaDevice" ], "default": "boot.VmediaDevice", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "boot.VmediaDevice" ], "default": "boot.VmediaDevice", "x-enum-as-string": true }, "ComputePhysical": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "boot.VmediaDevice.List": { "title": "List of 'boot.VmediaDevice' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'boot.VmediaDevice' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'boot.VmediaDevice' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/boot.VmediaDevice" }, "nullable": true } } } ] }, "capability.ActionsMetaData.Response": { "description": "The response body of a HTTP GET request for the 'capability.ActionsMetaData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ActionsMetaData' resources.", "x-one-of-name": "capability.ActionsMetaData.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ActionsMetaData.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ActionsMetaData": { "title": "Capability:Actions Meta Data", "description": "The ActionsMetaData object helps in managing third-party server actions within Cisco's Intersight platform. This provides metadata and constraints necessary to validate actions before they are executed, ensuring that operations are permissible according to defined rules.\n#### Purpose\nActionsMetaData ensures that server actions are carried out only after successful validation against specified targets. It serves as a control mechanism to maintain integrity and compliance in server operations, particularly when integrating third-party servers into the Intersight ecosystem.\n#### Key Concepts\n- **Validation:** The object includes attributes that help in validating server actions, such as firmware versions and server models.\n- **Privilege Management:** Defines various privilege sets needed to perform read, create, update, and delete operations, thereby controlling access to server actions.\n- **Integration:** Facilitates seamless integration of third-party servers by providing necessary metadata to support cross-platform operations.\n- **Security:** Ensures actions are compliant and secure by restricting operations based on validation outcomes.", "x-allOf-name": "capability.ActionsMetaData", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ActionsMetaData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ActionsMetaData" ], "default": "capability.ActionsMetaData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ActionsMetaData" ], "default": "capability.ActionsMetaData", "x-enum-as-string": true }, "MaxFwVersion": { "description": "Maximum firmware version of the server.", "type": "string", "x-omitempty": true }, "MinFwVersion": { "description": "Minimum firmware version of the server.", "type": "string", "x-omitempty": true }, "Model": { "description": "Model of the server that supports power or storage operations.", "type": "string", "x-omitempty": true }, "SelLogPath": { "description": "Location of Sel log script.", "type": "string", "readOnly": true, "x-omitempty": true }, "SelScriptFilePath": { "description": "Location of Sel file script.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedActions": { "type": "array", "items": { "description": "Set of actions supported for a particular server model.", "type": "string", "x-omitempty": true }, "nullable": true }, "TargetType": { "description": "The target type to which the metadata applies.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "x-omitempty": true }, "Vendor": { "description": "Manufacturer of the server.", "type": "string", "x-omitempty": true } } } ] }, "capability.ActionsMetaData.List": { "title": "List of 'capability.ActionsMetaData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ActionsMetaData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ActionsMetaData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ActionsMetaData" }, "nullable": true } } } ] }, "capability.AdapterConnectionPoint": { "title": "Capability:Adapter Connection Point", "description": "Adapter connection point in the PCIe topology.", "x-allOf-name": "capability.AdapterConnectionPoint", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.AdapterConnectionPoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.AdapterConnectionPoint" ], "default": "capability.AdapterConnectionPoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.AdapterConnectionPoint" ], "default": "capability.AdapterConnectionPoint", "x-enum-as-string": true }, "EndPointIds": { "type": "array", "items": { "description": "Collection of endpoint identifiers for the Smart NIC connection points.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "capability.AdapterDeprecatedDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.AdapterDeprecatedDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.AdapterDeprecatedDef' resources.", "x-one-of-name": "capability.AdapterDeprecatedDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.AdapterDeprecatedDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.AdapterDeprecatedDef": { "title": "Capability:Adapter Deprecated Def", "description": "The capability.AdapterDeprecatedDef object is a capability definition used to identify network adapters that are unsupported or have been deprecated in the current system release. It is typically used within a server descriptor to flag incompatible hardware.\n#### Purpose\nThe primary purpose of this object is to maintain a catalog of unsupported adapters. When a server is discovered, its adapters can be checked against this catalog. If a match is found, the system can raise an alarm or prevent certain operations, ensuring that only supported hardware configurations are used.\n#### Key Concepts\n- **Hardware Compatibility Catalog:** Acts as a list of known unsupported or deprecated adapters.\n- **Identification by Vendor and Model:** Uses vendor and model properties to uniquely identify an adapter type.\n- **Proactive Issue Detection:** Enables the system to flag potential support and functionality issues by identifying deprecated hardware during server inventory.\n- **Nested Definition:** Designed to be used as a sub-object within a capability.ServerDescriptor, linking unsupported adapters to specific server models where they are not applicable.", "x-allOf-name": "capability.AdapterDeprecatedDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.AdapterDeprecatedDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.AdapterDeprecatedDef" ], "default": "capability.AdapterDeprecatedDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.AdapterDeprecatedDef" ], "default": "capability.AdapterDeprecatedDef", "x-enum-as-string": true }, "Model": { "description": "Model of the unsupported adapter.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "Vendor of the unsupported adapter.", "type": "string", "x-omitempty": true } } } ] }, "capability.AdapterDeprecatedDef.List": { "title": "List of 'capability.AdapterDeprecatedDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.AdapterDeprecatedDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.AdapterDeprecatedDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.AdapterDeprecatedDef" }, "nullable": true } } } ] }, "capability.AdapterFirmwareRequirement.Response": { "description": "The response body of a HTTP GET request for the 'capability.AdapterFirmwareRequirement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.AdapterFirmwareRequirement' resources.", "x-one-of-name": "capability.AdapterFirmwareRequirement.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.AdapterFirmwareRequirement.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.AdapterFirmwareRequirement": { "title": "Capability:Adapter Firmware Requirement", "description": "Firmware requirements for enabling Intersight based management for an adaptor.", "x-allOf-name": "capability.AdapterFirmwareRequirement", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.AdapterFirmwareRequirement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.AdapterFirmwareRequirement" ], "default": "capability.AdapterFirmwareRequirement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.AdapterFirmwareRequirement" ], "default": "capability.AdapterFirmwareRequirement", "x-enum-as-string": true }, "AdapterSeries": { "description": "Series of adapter. Example - Cruz, Bodega.", "type": "string", "readOnly": true, "x-omitempty": true }, "IgnoreEmptyCurrentVersion": { "description": "Do not update if the current version is reported as empty.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MinimumAdapterVersion": { "description": "The minimum adapter version that supports this adapter upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinimumBmcVersion": { "description": "The minimum BMC version that supports this adapter upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "RecommendedBmcVersion": { "description": "The recommended BMC version that supports this adapter upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of adapter models which fall under this series of adapters.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.AdapterFirmwareRequirement.List": { "title": "List of 'capability.AdapterFirmwareRequirement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.AdapterFirmwareRequirement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.AdapterFirmwareRequirement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.AdapterFirmwareRequirement" }, "nullable": true } } } ] }, "capability.AdapterUnitDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.AdapterUnitDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.AdapterUnitDescriptor' resources.", "x-one-of-name": "capability.AdapterUnitDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.AdapterUnitDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.AdapterUnitDescriptor": { "title": "Capability:Adapter Unit Descriptor", "description": "The AdapterUnitDescriptor object uniquely identifies an adapter within a hardware environment. This provides detailed attributes and descriptors that facilitate the management and recognition of adapters for server integration and inventory purposes.\n#### Purpose\nAn AdapterUnitDescriptor acts as a detailed descriptor for adapters, ensuring precise identification and integration within server systems.\n#### Key Concepts\n- **Hardware Descriptor:** Serves as an extension of the base hardware descriptor, focusing on adapter-specific attributes.\n- **Inventory Integration:** Facilitates integration with inventory systems, ensuring accurate tracking and management of adapter resources.\n- **Access Control:** Managed through privilege sets to ensure secure handling of adapter descriptors, maintaining integrity and reliability.\n- **Comprehensive Attributes:** Includes detailed properties such as prom card type, DCE port count, and connectivity order, supporting thorough adapter management.", "x-allOf-name": "capability.AdapterUnitDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.AdapterUnitDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.AdapterUnitDescriptor" ], "default": "capability.AdapterUnitDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.AdapterUnitDescriptor" ], "default": "capability.AdapterUnitDescriptor", "x-enum-as-string": true }, "AdapterGeneration": { "description": "Generation of the adapter.\n* `4` - Fourth generation adapters (14xx). The PIDs of these adapters end with the string 04.\n* `2` - Second generation VIC adapters (12xx). The PIDs of these adapters end with the string 02.\n* `3` - Third generation adapters (13xx). The PIDs of these adapters end with the string 03.\n* `5` - Fifth generation adapters (15xx). The PIDs of these adapters contain the V5 string.", "type": "integer", "enum": [ 4, 2, 3, 5 ], "default": 4, "x-omitempty": true }, "ConnectivityOrder": { "description": "Order in which the ports are connected; sequential or cyclic.", "type": "string", "x-omitempty": true }, "EthernetPortSpeed": { "description": "The port speed for ethernet ports in Mbps.", "type": "integer", "format": "int64", "x-omitempty": true }, "Features": { "type": "array", "items": { "description": "Features supported on the adapter.", "$ref": "#/components/schemas/capability.FeatureConfig", "x-omitempty": true }, "nullable": true }, "FibreChannelPortSpeed": { "description": "The port speed for fibre channel ports in Mbps.", "type": "integer", "format": "int64", "x-omitempty": true }, "FibreChannelScsiIoqLimit": { "description": "The number of SCSI I/O Queue resources to allocate.", "type": "integer", "format": "int64", "x-omitempty": true }, "IsAzureQosSupported": { "description": "Indicates that the Azure Stack Host QoS feature is supported by this adapter.", "type": "boolean", "default": true, "x-omitempty": true }, "IsGeneveSupported": { "description": "Indicates that the GENEVE offload feature is supported by this adapter.", "type": "boolean", "default": true, "x-omitempty": true }, "IsPlacementApplicable": { "description": "This field determines whether vNICs can be placed to the adapters. It is mandatory for all adapters. For third-party adapters, this field is set to 'false', meaning they will only be inventoried, and no LCP configuration will be applied.", "type": "boolean", "default": true, "x-omitempty": true }, "IsSecureBootSupported": { "description": "Indicates support for secure boot.", "type": "boolean", "default": false, "x-omitempty": true }, "MaxEthRxRingSize": { "description": "Maximum Ring Size value for vNIC Receive Queue.", "type": "integer", "format": "int64", "default": 4096, "x-omitempty": true }, "MaxEthTxRingSize": { "description": "Maximum Ring Size value for vNIC Transmit Queue.", "type": "integer", "format": "int64", "default": 4096, "x-omitempty": true }, "MaxRocev2Interfaces": { "description": "Maximum number of vNIC interfaces that can be RoCEv2 enabled.", "type": "integer", "format": "int64", "default": 2, "x-omitempty": true }, "NumDcePorts": { "description": "Number of Dce Ports for the adapter.", "type": "integer", "format": "int64", "x-omitempty": true }, "NumberOfPciLinks": { "description": "Indicates number of PCI Links of the adapter.", "type": "integer", "format": "int64", "default": 1, "x-omitempty": true }, "PciLink": { "description": "Indicates PCI Link status of adapter.", "type": "integer", "format": "int64", "default": 0, "x-omitempty": true }, "PromCardType": { "description": "Prom card type for the adapter.", "type": "string", "x-omitempty": true }, "VicId": { "description": "Vic Id assigned for the adapter.", "type": "string", "x-omitempty": true } } } ] }, "capability.AdapterUnitDescriptor.List": { "title": "List of 'capability.AdapterUnitDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.AdapterUnitDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.AdapterUnitDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.AdapterUnitDescriptor" }, "nullable": true } } } ] }, "capability.AdapterUpdateConstraintMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.AdapterUpdateConstraintMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.AdapterUpdateConstraintMeta' resources.", "x-one-of-name": "capability.AdapterUpdateConstraintMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.AdapterUpdateConstraintMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.AdapterUpdateConstraintMeta": { "title": "Capability:Adapter Update Constraint Meta", "description": "Internal meta-data to enable adapter unit update related constraints.", "x-allOf-name": "capability.AdapterUpdateConstraintMeta", "allOf": [ { "$ref": "#/components/schemas/capability.UpdateConstraintMeta" } ] }, "capability.AdapterUpdateConstraintMeta.List": { "title": "List of 'capability.AdapterUpdateConstraintMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.AdapterUpdateConstraintMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.AdapterUpdateConstraintMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.AdapterUpdateConstraintMeta" }, "nullable": true } } } ] }, "capability.AdapterUpgradeSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.AdapterUpgradeSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.AdapterUpgradeSupportMeta' resources.", "x-one-of-name": "capability.AdapterUpgradeSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.AdapterUpgradeSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.AdapterUpgradeSupportMeta": { "title": "Capability:Adapter Upgrade Support Meta", "description": "Internal meta-data to enable adapter upgrade related decision making.", "x-allOf-name": "capability.AdapterUpgradeSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.AdapterUpgradeSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.AdapterUpgradeSupportMeta" ], "default": "capability.AdapterUpgradeSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.AdapterUpgradeSupportMeta" ], "default": "capability.AdapterUpgradeSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Information related to the list of adapters.", "type": "string", "readOnly": true, "x-omitempty": true }, "SeriesId": { "description": "Series name of the adapter which will be supported in firmware operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of adapter models which fall under this series of adapters.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.AdapterUpgradeSupportMeta.List": { "title": "List of 'capability.AdapterUpgradeSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.AdapterUpgradeSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.AdapterUpgradeSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.AdapterUpgradeSupportMeta" }, "nullable": true } } } ] }, "capability.BiosTokens.Response": { "description": "The response body of a HTTP GET request for the 'capability.BiosTokens' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.BiosTokens' resources.", "x-one-of-name": "capability.BiosTokens.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.BiosTokens.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.BiosTokens": { "title": "Capability:Bios Tokens", "description": "Bios Tokens place holder for mappping intersight types to end point keys.", "x-allOf-name": "capability.BiosTokens", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.BiosTokens', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.BiosTokens" ], "default": "capability.BiosTokens", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.BiosTokens" ], "default": "capability.BiosTokens", "x-enum-as-string": true }, "BiosTokensMap": { "description": "Place holder for Bios Attribute Registry.", "nullable": true, "readOnly": true, "x-omitempty": true }, "Version": { "description": "Version of the Bios Attribute Registry.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.BiosTokens.List": { "title": "List of 'capability.BiosTokens' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.BiosTokens' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.BiosTokens' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.BiosTokens" }, "nullable": true } } } ] }, "capability.Capability.Relationship": { "description": "A relationship to the 'capability.Capability' resource, or the expanded 'capability.Capability' resource, or the 'null' value.", "x-one-of-name": "capability.Capability.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/capability.Capability" } ], "discriminator": { "propertyName": "ClassId" } }, "capability.Capability": { "title": "Capability:Capability", "description": "Abstract type that defines properties common for all capability descriptors.", "x-allOf-name": "capability.Capability", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.Capability', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.ActionsMetaData", "capability.AdapterDeprecatedDef", "capability.AdapterFirmwareRequirement", "capability.AdapterUpdateConstraintMeta", "capability.AdapterUpgradeSupportMeta", "capability.BiosTokens", "capability.ChassisManufacturingDef", "capability.ChassisUpgradeSupportMeta", "capability.DomainPolicyRequirement", "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.FanModuleManufacturingDef", "capability.FexCapabilityDef", "capability.FexManufacturingDef", "capability.FexSupportMeta", "capability.HsuIsoFileSupportMeta", "capability.IoCardCapabilityDef", "capability.IoCardManufacturingDef", "capability.IomUpgradeSupportMeta", "capability.NetworkEquipmentPowerDef", "capability.PolicyConstants", "capability.PortGroupAggregationDef", "capability.ProcessorUnitUpdateConstraintMeta", "capability.PsuManufacturingDef", "capability.ServerActionsMeta", "capability.ServerModelsCapabilityDef", "capability.ServerPcieConnectivityCatalog", "capability.ServerTopologyMap", "capability.ServerUpgradeSupportMeta", "capability.SiocModuleCapabilityDef", "capability.SiocModuleManufacturingDef", "capability.StandardRedfishSupportMeta", "capability.StorageControllerUpdateConstraintMeta", "capability.StorageControllersMetaData", "capability.SwitchCapability", "capability.SwitchEquipmentInfo", "capability.SwitchManufacturingDef", "capability.SwitchUpgradeSupportMeta", "capability.TemplateCatalog", "capability.TimeZoneMetaData", "capability.UpdateOrderMeta", "capability.VicDescriptor", "softwarerepository.CategoryMapper", "softwarerepository.CategoryMapperModel", "softwarerepository.CategorySupportConstraint", "softwarerepository.CategoryUnsupportedModels" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.ActionsMetaData", "capability.AdapterDeprecatedDef", "capability.AdapterFirmwareRequirement", "capability.AdapterUpdateConstraintMeta", "capability.AdapterUpgradeSupportMeta", "capability.BiosTokens", "capability.ChassisManufacturingDef", "capability.ChassisUpgradeSupportMeta", "capability.DomainPolicyRequirement", "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.FanModuleManufacturingDef", "capability.FexCapabilityDef", "capability.FexManufacturingDef", "capability.FexSupportMeta", "capability.HsuIsoFileSupportMeta", "capability.IoCardCapabilityDef", "capability.IoCardManufacturingDef", "capability.IomUpgradeSupportMeta", "capability.NetworkEquipmentPowerDef", "capability.PolicyConstants", "capability.PortGroupAggregationDef", "capability.ProcessorUnitUpdateConstraintMeta", "capability.PsuManufacturingDef", "capability.ServerActionsMeta", "capability.ServerModelsCapabilityDef", "capability.ServerPcieConnectivityCatalog", "capability.ServerTopologyMap", "capability.ServerUpgradeSupportMeta", "capability.SiocModuleCapabilityDef", "capability.SiocModuleManufacturingDef", "capability.StandardRedfishSupportMeta", "capability.StorageControllerUpdateConstraintMeta", "capability.StorageControllersMetaData", "capability.SwitchCapability", "capability.SwitchEquipmentInfo", "capability.SwitchManufacturingDef", "capability.SwitchUpgradeSupportMeta", "capability.TemplateCatalog", "capability.TimeZoneMetaData", "capability.UpdateOrderMeta", "capability.VicDescriptor", "softwarerepository.CategoryMapper", "softwarerepository.CategoryMapperModel", "softwarerepository.CategorySupportConstraint", "softwarerepository.CategoryUnsupportedModels" ], "x-enum-as-string": true }, "Name": { "description": "An unique identifer for a capability descriptor.", "type": "string", "x-omitempty": true } } } ] }, "capability.Catalog.Response": { "description": "The response body of a HTTP GET request for the 'capability.Catalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.Catalog' resources.", "x-one-of-name": "capability.Catalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.Catalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.Catalog": { "title": "Capability:Catalog", "description": "Container for capability information of managed systems.\nThis catalog will be managed by devops using a specific role in the Catalog Admin account.", "x-allOf-name": "capability.Catalog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.Catalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.Catalog" ], "default": "capability.Catalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.Catalog" ], "default": "capability.Catalog", "x-enum-as-string": true }, "Name": { "description": "A unique name for the catalog.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "capability.Catalog.List": { "title": "List of 'capability.Catalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.Catalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.Catalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.Catalog" }, "nullable": true } } } ] }, "capability.CertificatePropertyConstraints": { "title": "Capability:Certificate Property Constraints", "description": "Constraints to be validated for Certificate policy.", "x-allOf-name": "capability.CertificatePropertyConstraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.CertificatePropertyConstraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.CertificatePropertyConstraints" ], "default": "capability.CertificatePropertyConstraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.CertificatePropertyConstraints" ], "default": "capability.CertificatePropertyConstraints", "x-enum-as-string": true }, "NumOfRootCertificatesSupported": { "description": "Maximum number of root Certificates supported in FI.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "capability.ChassisDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.ChassisDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ChassisDescriptor' resources.", "x-one-of-name": "capability.ChassisDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ChassisDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ChassisDescriptor": { "title": "Capability:Chassis Descriptor", "description": "Descriptor that uniquely identifies an chassis enclosure.", "x-allOf-name": "capability.ChassisDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ChassisDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ChassisDescriptor" ], "default": "capability.ChassisDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ChassisDescriptor" ], "default": "capability.ChassisDescriptor", "x-enum-as-string": true }, "Revision": { "description": "Revision for the chassis enclosure.", "type": "string", "x-omitempty": true } } } ] }, "capability.ChassisDescriptor.List": { "title": "List of 'capability.ChassisDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ChassisDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ChassisDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ChassisDescriptor" }, "nullable": true } } } ] }, "capability.ChassisManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.ChassisManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ChassisManufacturingDef' resources.", "x-one-of-name": "capability.ChassisManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ChassisManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ChassisManufacturingDef": { "title": "Capability:Chassis Manufacturing Def", "description": "Chassis enclosure manufacturing def properties.", "x-allOf-name": "capability.ChassisManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ChassisManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ChassisManufacturingDef" ], "default": "capability.ChassisManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ChassisManufacturingDef" ], "default": "capability.ChassisManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for Chassis enclosure.", "type": "string", "x-omitempty": true }, "ChassisCodeName": { "description": "Chassis Code Name for Chassis enclosure.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for Chassis enclosure.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a Chassis enclosure.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for Chassis enclosure.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for Chassis enclosure.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for Chassis enclosure.", "type": "string", "x-omitempty": true } } } ] }, "capability.ChassisManufacturingDef.List": { "title": "List of 'capability.ChassisManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ChassisManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ChassisManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ChassisManufacturingDef" }, "nullable": true } } } ] }, "capability.ChassisUpgradeSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.ChassisUpgradeSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ChassisUpgradeSupportMeta' resources.", "x-one-of-name": "capability.ChassisUpgradeSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ChassisUpgradeSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ChassisUpgradeSupportMeta": { "title": "Capability:Chassis Upgrade Support Meta", "description": "Internal meta-data to enable chassis upgrade related decision making.", "x-allOf-name": "capability.ChassisUpgradeSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ChassisUpgradeSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ChassisUpgradeSupportMeta" ], "default": "capability.ChassisUpgradeSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ChassisUpgradeSupportMeta" ], "default": "capability.ChassisUpgradeSupportMeta", "x-enum-as-string": true }, "AdaptersUpgradedViaHsu": { "description": "If enabled, indicates that adapters in servers within this chassis would be upgraded by HSU.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Verbose description regarding this group of chassis.", "type": "string", "readOnly": true, "x-omitempty": true }, "SeriesId": { "description": "Classification of a set of chassis models.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of chassis models which belong to this series.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SupportedPsuModels": { "type": "array", "items": { "description": "List of PSU models which belong to this series.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SupportedXfmModels": { "type": "array", "items": { "description": "List of XFM models which belong to this series.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.ChassisUpgradeSupportMeta.List": { "title": "List of 'capability.ChassisUpgradeSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ChassisUpgradeSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ChassisUpgradeSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ChassisUpgradeSupportMeta" }, "nullable": true } } } ] }, "capability.CimcFirmwareDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.CimcFirmwareDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.CimcFirmwareDescriptor' resources.", "x-one-of-name": "capability.CimcFirmwareDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.CimcFirmwareDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.CimcFirmwareDescriptor": { "title": "Capability:Cimc Firmware Descriptor", "description": "The capability.CimcFirmwareDescriptor is a hardware descriptor object that defines server capabilities based on its Cisco Integrated Management Controller (CIMC) firmware version. It is used to determine feature support for specific firmware releases.\n#### Purpose\nThe main purpose of this object is to create a catalog that maps CIMC firmware versions to specific features. This allows the management system to dynamically determine if a server's firmware supports functionalities like UUID-based identification or local user password management, ensuring that operations are only attempted on compatible firmware.\n#### Key Concepts\n- **Firmware-Based Capability Mapping:** Links server capabilities directly to the vendor, model, and version of its CIMC firmware.\n- **Feature Support Gates:** Provides minimum firmware versions (uuidSupportedVer, localUserPswdSupportedVer) required for certain features to be available.\n- **Integration Logic:** Informs the system about specific integration details, such as whether the server uses an endpoint proxy (adapterEpProxyEnabled) to communicate with its adapters.\n- **Extensible Catalog:** As a HardwareDescriptor, it is part of an extensible catalog that can be updated to reflect new firmware releases and their corresponding capabilities.", "x-allOf-name": "capability.CimcFirmwareDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.CimcFirmwareDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.CimcFirmwareDescriptor" ], "default": "capability.CimcFirmwareDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.CimcFirmwareDescriptor" ], "default": "capability.CimcFirmwareDescriptor", "x-enum-as-string": true }, "AdapterEpProxyEnabled": { "description": "Indicates whether the server uses ep proxy to communicate with the adapter.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LocalUserPswdSupportedVer": { "description": "Minimum server firmware version for local users password properties feature support.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyProfileSupportedVersion": { "description": "Minimum server firmware version for policy profile feature support.", "type": "string", "readOnly": true, "x-omitempty": true }, "Revision": { "description": "Revision information for the server.", "type": "string", "x-omitempty": true }, "UuidSupportedVer": { "description": "Minimum server firmware version for UUID feature support.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.CimcFirmwareDescriptor.List": { "title": "List of 'capability.CimcFirmwareDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.CimcFirmwareDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.CimcFirmwareDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.CimcFirmwareDescriptor" }, "nullable": true } } } ] }, "capability.CpuEndpointDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.CpuEndpointDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.CpuEndpointDescriptor' resources.", "x-one-of-name": "capability.CpuEndpointDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.CpuEndpointDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.CpuEndpointDescriptor": { "title": "Capability:Cpu Endpoint Descriptor", "description": "The capability.CpuEndpointDescriptor object is a descriptor used to uniquely identify a CPU (Central Processing Unit) within the capability catalog. It serves as an inventory record for CPU models, providing key identification details.\n#### Purpose\nThe purpose of this object is to maintain a definitive catalog of supported CPU models. It stores essential information such as the vendor, model, pid (Product ID), and partNumber. This catalog can be used to validate the CPUs installed in a server, check for compatibility, and provide detailed inventory reports.\n#### Key Concepts\n- **CPU Cataloging:** Provides a structured way to catalog and manage information about different CPU models.\n- **Unique Identification:** Uses a combination of vendor, model, and pid to uniquely identify each CPU type.\n- **Platform Support:** The supportedPlatformsPids property links a CPU to the specific server platforms on which it is supported, enabling compatibility checks.\n- **Read-Only Inventory:** Designed as a read-only reference, ensuring the integrity of the hardware capability data.", "x-allOf-name": "capability.CpuEndpointDescriptor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.CpuEndpointDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.CpuEndpointDescriptor" ], "default": "capability.CpuEndpointDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.CpuEndpointDescriptor" ], "default": "capability.CpuEndpointDescriptor", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description of the cpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field is to provide model of the cpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field is to provide partNumber of the cpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field is to provide pid of the cpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedPlatformsPids": { "type": "array", "items": { "description": "The platforms in which the cpu is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "This field is to provide vendor of the cpu.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.CpuEndpointDescriptor.List": { "title": "List of 'capability.CpuEndpointDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.CpuEndpointDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.CpuEndpointDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.CpuEndpointDescriptor" }, "nullable": true } } } ] }, "capability.DeviceInventory": { "title": "Device inventory", "description": "Hardware device inventory information including model and version details.", "x-allOf-name": "capability.DeviceInventory", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.DeviceInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.DeviceInventory" ], "default": "capability.DeviceInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.DeviceInventory" ], "default": "capability.DeviceInventory", "x-enum-as-string": true }, "DeviceObjectType": { "description": "The type classification of the endpoint device.", "type": "string", "x-omitempty": true }, "MaxVersion": { "description": "The maximum firmware or software version supported by this endpoint.", "type": "string", "x-omitempty": true }, "MinVersion": { "description": "The minimum firmware or software version supported by this endpoint.", "type": "string", "x-omitempty": true }, "Model": { "description": "The specific model identifier of the endpoint device.", "type": "string", "x-omitempty": true } } } ] }, "capability.DimmsEndpointDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.DimmsEndpointDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.DimmsEndpointDescriptor' resources.", "x-one-of-name": "capability.DimmsEndpointDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.DimmsEndpointDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.DimmsEndpointDescriptor": { "title": "Capability:Dimms Endpoint Descriptor", "description": "The capability.DimmsEndpointDescriptor object is a descriptor used to uniquely identify a DIMM (Dual In-line Memory Module) within the capability catalog. It functions as a primary inventory record for memory module models.\n#### Purpose\nThe primary purpose of this object is to maintain a comprehensive catalog of supported DIMM models. It stores key identification details, including vendor, model, pid (Product ID), and partNumber. This catalog is essential for validating memory configurations, verifying compatibility with server platforms, and providing accurate inventory data.\n#### Key Concepts\n- **Memory Module Catalog:** Establishes a structured repository for information about different DIMM models.\n- **Unique Identification:** Uses a combination of vendor, model, and pid to uniquely define each type of DIMM.\n- **Compatibility Mapping:** The supportedPlatformsPids property links each DIMM to the server platforms it is certified for, which is critical for configuration validation.\n- **Reference Data:** Serves as a read-only source of truth for DIMM specifications, used by the system for inventory and validation purposes.", "x-allOf-name": "capability.DimmsEndpointDescriptor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.DimmsEndpointDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.DimmsEndpointDescriptor" ], "default": "capability.DimmsEndpointDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.DimmsEndpointDescriptor" ], "default": "capability.DimmsEndpointDescriptor", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description of the dimm.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field is to provide model of the dimm.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field is to provide partNumber of the dimm.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field is to provide pid of the dimm.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedPlatformsPids": { "type": "array", "items": { "description": "The platforms in which the dimm is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "This field is to provide vendor of the dimm.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.DimmsEndpointDescriptor.List": { "title": "List of 'capability.DimmsEndpointDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.DimmsEndpointDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.DimmsEndpointDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.DimmsEndpointDescriptor" }, "nullable": true } } } ] }, "capability.DomainPolicyRequirement.Response": { "description": "The response body of a HTTP GET request for the 'capability.DomainPolicyRequirement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.DomainPolicyRequirement' resources.", "x-one-of-name": "capability.DomainPolicyRequirement.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.DomainPolicyRequirement.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.DomainPolicyRequirement": { "title": "Capability:Domain Policy Requirement", "description": "Version Constraint requirement for a domian policy.", "x-allOf-name": "capability.DomainPolicyRequirement", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.DomainPolicyRequirement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.DomainPolicyRequirement" ], "default": "capability.DomainPolicyRequirement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.DomainPolicyRequirement" ], "default": "capability.DomainPolicyRequirement", "x-enum-as-string": true }, "CertificatePolicyConstraints": { "description": "Certificate policy specific constraints applicable for this model.", "$ref": "#/components/schemas/capability.CertificatePropertyConstraints", "readOnly": true, "x-omitempty": true }, "LdapConstraints": { "description": "Ldap policy specific constraints applicable for this model.", "$ref": "#/components/schemas/capability.LdapBasePropertyConstraints", "readOnly": true, "x-omitempty": true }, "MinBundleVersion": { "description": "Minimum Bundle version from which it is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinVersion": { "description": "Minimum Version from which policy is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "Type of the platform for which version compatibility is specified. Example - 3GFI, 4GFI, etc.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "Policy Name for which version compatibility is specified. Example - snmp.Policy, ldap.Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortPolicyConstraints": { "description": "Port policy specific constraints applicable for this model.", "$ref": "#/components/schemas/capability.PortPropertyConstraints", "readOnly": true, "x-omitempty": true }, "SwitchControlPolicyConstraints": { "description": "Switch control policy specific constraints applicable for this model.", "$ref": "#/components/schemas/capability.SwitchControlPolicyConstraints", "readOnly": true, "x-omitempty": true } } } ] }, "capability.DomainPolicyRequirement.List": { "title": "List of 'capability.DomainPolicyRequirement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.DomainPolicyRequirement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.DomainPolicyRequirement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.DomainPolicyRequirement" }, "nullable": true } } } ] }, "capability.DrivesEndpointDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.DrivesEndpointDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.DrivesEndpointDescriptor' resources.", "x-one-of-name": "capability.DrivesEndpointDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.DrivesEndpointDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.DrivesEndpointDescriptor": { "title": "Capability:Drives Endpoint Descriptor", "description": "The capability.DrivesEndpointDescriptor object is a descriptor used to uniquely identify a storage drive (e.g., HDD, SSD) within the capability catalog. It serves as a centralized inventory record for all supported drive models.\n#### Purpose\nThe main function of this object is to create and maintain a definitive catalog of storage drives. It stores essential identification attributes like vendor, model, pid (Product ID), and partNumber. This catalog is used by the system to validate drive compatibility with server platforms, verify hardware configurations, and provide detailed inventory reports.\n#### Key Concepts\n- **Storage Drive Catalog:** Provides a structured system for managing information about various drive models.\n- **Unique Identification:** Uniquely identifies each drive type using a combination of vendor, model, and pid.\n- **Alias Support:** The aliasModel property allows for mapping multiple model names to a single descriptor, accommodating vendor rebranding or minor variations.\n- **Platform Compatibility:** The supportedPlatformsPids list links each drive to the specific server platforms it is supported on, enabling automated compatibility checks.", "x-allOf-name": "capability.DrivesEndpointDescriptor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.DrivesEndpointDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.DrivesEndpointDescriptor" ], "default": "capability.DrivesEndpointDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.DrivesEndpointDescriptor" ], "default": "capability.DrivesEndpointDescriptor", "x-enum-as-string": true }, "AliasModel": { "description": "This field is to provide alias model of the drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field is to provide description of the drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field is to provide model of the drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field is to provide partNumber of the drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field is to provide pid of the drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedPlatformsPids": { "type": "array", "items": { "description": "The platforms in which the drive is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "This field is to provide vendor of the drive.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.DrivesEndpointDescriptor.List": { "title": "List of 'capability.DrivesEndpointDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.DrivesEndpointDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.DrivesEndpointDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.DrivesEndpointDescriptor" }, "nullable": true } } } ] }, "capability.EndpointDescriptor": { "title": "Capability:Endpoint Descriptor", "description": "Abstract type that defines properties common for all endpoint descriptors. An endpoint descriptor is used to uniquely identify a type of endpoint.", "x-allOf-name": "capability.EndpointDescriptor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.EndpointDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.AdapterUnitDescriptor", "capability.ChassisDescriptor", "capability.CimcFirmwareDescriptor", "capability.FanModuleDescriptor", "capability.FexDescriptor", "capability.IoCardDescriptor", "capability.PsuDescriptor", "capability.ServerDescriptor", "capability.ServerSchemaDescriptor", "capability.SiocModuleDescriptor", "capability.SwitchDescriptor", "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.DriveDescriptor", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PcieDescriptor", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.SasExpanderDescriptor", "firmware.StorageControllerDescriptor" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.AdapterUnitDescriptor", "capability.ChassisDescriptor", "capability.CimcFirmwareDescriptor", "capability.FanModuleDescriptor", "capability.FexDescriptor", "capability.IoCardDescriptor", "capability.PsuDescriptor", "capability.ServerDescriptor", "capability.ServerSchemaDescriptor", "capability.SiocModuleDescriptor", "capability.SwitchDescriptor", "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.DriveDescriptor", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PcieDescriptor", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.SasExpanderDescriptor", "firmware.StorageControllerDescriptor" ], "x-enum-as-string": true }, "Description": { "description": "Detailed information about the endpoint.", "type": "string", "x-omitempty": true }, "Model": { "description": "The model of the endpoint, for which this capability information is applicable.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "The vendor of the endpoint, for which this capability information is applicable.", "type": "string", "x-omitempty": true }, "Version": { "description": "The firmware or software version of the endpoint, for which this capability information is applicable.", "type": "string", "x-omitempty": true }, "Capabilities": { "description": "An array of relationships to capabilityCapability resources.", "type": "array", "items": { "$ref": "#/components/schemas/capability.Capability.Relationship" }, "nullable": true } } } ] }, "capability.EquipmentPhysicalDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.EquipmentPhysicalDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.EquipmentPhysicalDef' resources.", "x-one-of-name": "capability.EquipmentPhysicalDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.EquipmentPhysicalDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.EquipmentPhysicalDef": { "title": "Capability:Equipment Physical Def", "description": "Type to represent additional switch specific capabilities.", "x-allOf-name": "capability.EquipmentPhysicalDef", "allOf": [ { "$ref": "#/components/schemas/capability.SwitchCapabilityDef" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.EquipmentPhysicalDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.EquipmentPhysicalDef" ], "default": "capability.EquipmentPhysicalDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.EquipmentPhysicalDef" ], "default": "capability.EquipmentPhysicalDef", "x-enum-as-string": true }, "Depth": { "description": "Depth information for a Switch/Fabric-Interconnect.", "type": "number", "format": "float", "x-omitempty": true }, "Height": { "description": "Height information for a Switch/Fabric-Interconnect.", "type": "number", "format": "float", "x-omitempty": true }, "MaxPower": { "description": "Max Power information for a Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MinPower": { "description": "Min Power information for a Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "NominalPower": { "description": "Nominal Power information for a Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "Weight": { "description": "Weight information for a Switch/Fabric-Interconnect.", "type": "number", "format": "float", "x-omitempty": true }, "Width": { "description": "Width information for a Switch/Fabric-Interconnect.", "type": "number", "format": "float", "x-omitempty": true } } } ] }, "capability.EquipmentPhysicalDef.List": { "title": "List of 'capability.EquipmentPhysicalDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.EquipmentPhysicalDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.EquipmentPhysicalDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.EquipmentPhysicalDef" }, "nullable": true } } } ] }, "capability.EquipmentSlotArray.Response": { "description": "The response body of a HTTP GET request for the 'capability.EquipmentSlotArray' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.EquipmentSlotArray' resources.", "x-one-of-name": "capability.EquipmentSlotArray.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.EquipmentSlotArray.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.EquipmentSlotArray": { "title": "Capability:Equipment Slot Array", "description": "Type to represent additional switch specific capabilities.", "x-allOf-name": "capability.EquipmentSlotArray", "allOf": [ { "$ref": "#/components/schemas/capability.SwitchCapabilityDef" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.EquipmentSlotArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.EquipmentSlotArray" ], "default": "capability.EquipmentSlotArray", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.EquipmentSlotArray" ], "default": "capability.EquipmentSlotArray", "x-enum-as-string": true }, "FirstIndex": { "description": "First Index information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "Height": { "description": "Height information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "HorizontalStartOffset": { "description": "Horizontal Start Offset information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "InlineGroupSeparation": { "description": "Inline Group Separation information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "InlineGroupSize": { "description": "Inline Group Size information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "InlineOffset": { "description": "Inline Offset information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "Location": { "description": "Location information for a Switch/Fabric-Interconnect hardware.", "type": "string", "x-omitempty": true }, "NumberOfSlots": { "description": "Number of Slots information for a Switch/Fabric-Interconnect hardware.", "type": "integer", "format": "int64", "x-omitempty": true }, "Orientation": { "description": "Orientation information for a Switch/Fabric-Interconnect hardware.", "type": "string", "x-omitempty": true }, "Selector": { "description": "Selector information for a Switch/Fabric-Interconnect hardware.", "type": "string", "x-omitempty": true }, "SlotsPerLine": { "description": "Slots per line information for a Switch/Fabric-Interconnect hardware.", "type": "integer", "format": "int64", "x-omitempty": true }, "TransverseGroupSeparation": { "description": "Transverse Group Separation information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "TransverseGroupSize": { "description": "Transverse Group Size information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "TransverseOffset": { "description": "Transverse Offset information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "VerticalStartOffset": { "description": "Vertical Start Offset information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true }, "Width": { "description": "Width information for a Switch/Fabric-Interconnect hardware.", "type": "number", "format": "float", "x-omitempty": true } } } ] }, "capability.EquipmentSlotArray.List": { "title": "List of 'capability.EquipmentSlotArray' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.EquipmentSlotArray' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.EquipmentSlotArray' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.EquipmentSlotArray" }, "nullable": true } } } ] }, "capability.FanModuleDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.FanModuleDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FanModuleDescriptor' resources.", "x-one-of-name": "capability.FanModuleDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FanModuleDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FanModuleDescriptor": { "title": "Capability:Fan Module Descriptor", "description": "The capability.FanModuleDescriptor object is a hardware descriptor that uniquely identifies a fan module within the capability catalog. It serves as an inventory record for specific models of fan modules used in chassis and other equipment.\n#### Purpose\nThe purpose of this object is to maintain a catalog of known fan module models. It captures key identification details such as vendor, model, version, and revision. This allows the system to validate the hardware components of a chassis or server, ensuring that only supported and compatible fan modules are recognized.\n#### Key Concepts\n- **Hardware Cataloging:** Provides a structured entry for a specific fan module model in the system's hardware catalog.\n- **Unique Identification:** Uses a composite key of vendor, model, version, and revision to uniquely identify a fan module type.\n- **Component Validation:** Enables the system to verify that the fan modules discovered in a chassis match the known, supported hardware definitions.\n- **Extensible Descriptor:** As a HardwareDescriptor, it is part of a flexible and extensible catalog system.", "x-allOf-name": "capability.FanModuleDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FanModuleDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FanModuleDescriptor" ], "default": "capability.FanModuleDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FanModuleDescriptor" ], "default": "capability.FanModuleDescriptor", "x-enum-as-string": true }, "Revision": { "description": "Revision for the chassis enclosure.", "type": "string", "x-omitempty": true } } } ] }, "capability.FanModuleDescriptor.List": { "title": "List of 'capability.FanModuleDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FanModuleDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FanModuleDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FanModuleDescriptor" }, "nullable": true } } } ] }, "capability.FanModuleManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.FanModuleManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FanModuleManufacturingDef' resources.", "x-one-of-name": "capability.FanModuleManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FanModuleManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FanModuleManufacturingDef": { "title": "Capability:Fan Module Manufacturing Def", "description": "The capability.FanModuleManufacturingDef object is a capability definition that stores manufacturing-specific details for a fan module. This provides a comprehensive set of identifiers used for inventory and product identification.\n#### Purpose\nThis object's primary function is to serve as a reference for the manufacturing details of a fan module unit, which may contain multiple individual fans. It aggregates key product identifiers like pid (Product Identifier), vid (Vendor ID), sku (Stock Keeping Unit), and productName. This information is crucial for accurate inventory management, asset tracking, and support.\n#### Key Concepts\n- **Manufacturing Data:** Centralizes key manufacturing and product identifiers for a fan module.\n- **Product Identification:** Provides standard identifiers (pid, sku, productName) for easy lookup and integration with other systems like ordering and support tools.\n- **Descriptive Information:** Includes a caption and description to provide human-readable context about the fan module.\n- **Capability Reference:** Acts as a definition within the capability catalog, referenced by other objects to retrieve detailed manufacturing information.", "x-allOf-name": "capability.FanModuleManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FanModuleManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FanModuleManufacturingDef" ], "default": "capability.FanModuleManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FanModuleManufacturingDef" ], "default": "capability.FanModuleManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for a fan module.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for a fan module.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a fan module.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for Fan Module Unit.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for a fan module.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for a fan module.", "type": "string", "x-omitempty": true } } } ] }, "capability.FanModuleManufacturingDef.List": { "title": "List of 'capability.FanModuleManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FanModuleManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FanModuleManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FanModuleManufacturingDef" }, "nullable": true } } } ] }, "capability.FeatureConfig": { "title": "Feature Configuration", "description": "Configuration specific to the adapter feature.", "x-allOf-name": "capability.FeatureConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FeatureConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FeatureConfig" ], "default": "capability.FeatureConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FeatureConfig" ], "default": "capability.FeatureConfig", "x-enum-as-string": true }, "FeatureName": { "description": "Name of the feature that identifies the specific adapter configuration.\n* `RoCEv2` - Capability indicator of the RDMA over Converged Ethernet (RoCE) feature version 2.\n* `RoCEv1` - Capability indicator of the RDMA over Converged Ethernet (RoCE) feature version 1.\n* `VMQ` - Capability indicator of the Virtual Machine Queue (VMQ) feature.\n* `VMMQ` - Capability indicator of the Virtual Machine Multi-Queue (VMMQ) feature.\n* `VMQInterrupts` - Capability indicator of the Virtual Machine Queue (VMQ) Interrupts feature.\n* `NVGRE` - Capability indicator of the Network Virtualization using Generic Routing Encapsulation (NVGRE) feature.\n* `ARFS` - Capability indicator of the Accelerated Receive Flow Steering (ARFS) feature.\n* `VXLAN` - Capability indicator of the Virtual Extensible LAN (VXLAN) feature.\n* `usNIC` - Capability indicator of the User Space NIC (usNIC) feature.\n* `Advanced Filter` - Capability indicator of the Advanced Filter feature.\n* `Azure Stack Host QOS` - Capability indicator of the Azure Stack Host QOS feature.\n* `GENEVE Offload` - Capability indicator of the Generic Network Virtualization Encapsulation (Geneve) Offload feature.\n* `QinQ` - Capability indicator of the QinQ feature.\n* `SRIOV` - Capability indicator of the Single Root Input Output Virtualization (SR-IOV).\n* `Ether Channel Pinning` - Capability indicator of the Ether Channel Pinning feature.\n* `IPv6 Iscsi Boot` - Capability indicator of the Iscsi Boot via IPV6 protocol.", "type": "string", "enum": [ "RoCEv2", "RoCEv1", "VMQ", "VMMQ", "VMQInterrupts", "NVGRE", "ARFS", "VXLAN", "usNIC", "Advanced Filter", "Azure Stack Host QOS", "GENEVE Offload", "QinQ", "SRIOV", "Ether Channel Pinning", "IPv6 Iscsi Boot" ], "default": "RoCEv2", "x-omitempty": true }, "MinAdapterFwVersion": { "description": "Firmware version of Adapter from which support for this feature is available.", "type": "string", "x-omitempty": true }, "MinFwVersion": { "description": "Firmware version of BMC from which support for this feature is available.", "type": "string", "x-omitempty": true }, "SupportedFwVersions": { "type": "array", "items": { "description": "Support available on select firmware versions.", "type": "string", "x-omitempty": true }, "nullable": true }, "SupportedInAdapters": { "type": "array", "items": { "description": "Feature support is available on select adapters.", "type": "string", "x-omitempty": true }, "nullable": true }, "SupportedInGenerations": { "type": "array", "items": { "description": "The adapter generations that support this feature.\n* `4` - Fourth generation adapters (14xx). The PIDs of these adapters end with the string 04.\n* `2` - Second generation VIC adapters (12xx). The PIDs of these adapters end with the string 02.\n* `3` - Third generation adapters (13xx). The PIDs of these adapters end with the string 03.\n* `5` - Fifth generation adapters (15xx). The PIDs of these adapters contain the V5 string.", "type": "integer", "enum": [ 4, 2, 3, 5 ], "default": 4, "x-omitempty": true }, "nullable": true }, "UnsupportedFeatureMatrix": { "type": "array", "items": { "description": "The adapter generations that does not support these features for this feature.", "$ref": "#/components/schemas/capability.UnsupportedFeatureConfig", "x-omitempty": true }, "nullable": true }, "ValidationAction": { "description": "Action to be taken when validation does not succeed.\n* `Error` - Stop workflow execution by throwing error.\n* `Skip` - Remove the feature from configuration and continue workflow execution.", "type": "string", "enum": [ "Error", "Skip" ], "default": "Error", "x-omitempty": true } } } ] }, "capability.FexCapabilityDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.FexCapabilityDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FexCapabilityDef' resources.", "x-one-of-name": "capability.FexCapabilityDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FexCapabilityDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FexCapabilityDef": { "title": "Capability:Fex Capability Def", "description": "Fabric Extender module capabilities.", "x-allOf-name": "capability.FexCapabilityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FexCapabilityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FexCapabilityDef" ], "default": "capability.FexCapabilityDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FexCapabilityDef" ], "default": "capability.FexCapabilityDef", "x-enum-as-string": true }, "FecConfigOnHifPortSupported": { "description": "FEC config on HIF port for Fabric Extender.", "type": "boolean", "x-omitempty": true } } } ] }, "capability.FexCapabilityDef.List": { "title": "List of 'capability.FexCapabilityDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FexCapabilityDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FexCapabilityDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FexCapabilityDef" }, "nullable": true } } } ] }, "capability.FexDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.FexDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FexDescriptor' resources.", "x-one-of-name": "capability.FexDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FexDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FexDescriptor": { "title": "Capability:Fex Descriptor", "description": "Descriptor that uniquely identifies an Fabric extender.", "x-allOf-name": "capability.FexDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FexDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FexDescriptor" ], "default": "capability.FexDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FexDescriptor" ], "default": "capability.FexDescriptor", "x-enum-as-string": true }, "Revision": { "description": "Revision for the fabric extender.", "type": "string", "x-omitempty": true } } } ] }, "capability.FexDescriptor.List": { "title": "List of 'capability.FexDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FexDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FexDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FexDescriptor" }, "nullable": true } } } ] }, "capability.FexManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.FexManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FexManufacturingDef' resources.", "x-one-of-name": "capability.FexManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FexManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FexManufacturingDef": { "title": "Capability:Fex Manufacturing Def", "description": "Fabric extender manufacturing def properties.", "x-allOf-name": "capability.FexManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FexManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FexManufacturingDef" ], "default": "capability.FexManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FexManufacturingDef" ], "default": "capability.FexManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for Fabric extender.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for Fabric extender.", "type": "string", "x-omitempty": true }, "FexCodeName": { "description": "Code Name for Fabric extender.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a Fabric extender.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for Fabric extender.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for Fabric extender.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for Fabric extender.", "type": "string", "x-omitempty": true } } } ] }, "capability.FexManufacturingDef.List": { "title": "List of 'capability.FexManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FexManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FexManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FexManufacturingDef" }, "nullable": true } } } ] }, "capability.FexSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.FexSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.FexSupportMeta' resources.", "x-one-of-name": "capability.FexSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.FexSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.FexSupportMeta": { "title": "Capability:Fex Support Meta", "description": "Internal meta-data to enable block domain upgrade when certain FEX models are connected.", "x-allOf-name": "capability.FexSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.FexSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.FexSupportMeta" ], "default": "capability.FexSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.FexSupportMeta" ], "default": "capability.FexSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Information related to the list of FEXs.", "type": "string", "readOnly": true, "x-omitempty": true }, "SeriesId": { "description": "Series names of FEXs which will be unsupported in the firmware operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of FEX models which fall under this series of FEX.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.FexSupportMeta.List": { "title": "List of 'capability.FexSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.FexSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.FexSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.FexSupportMeta" }, "nullable": true } } } ] }, "capability.GpuConnectionPoint": { "title": "Capability:Gpu Connection Point", "description": "GPU connection point in the PCIe topology.", "x-allOf-name": "capability.GpuConnectionPoint", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.GpuConnectionPoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.GpuConnectionPoint" ], "default": "capability.GpuConnectionPoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.GpuConnectionPoint" ], "default": "capability.GpuConnectionPoint", "x-enum-as-string": true }, "EndPointIds": { "type": "array", "items": { "description": "Collection of endpoint identifiers for the GPU connection points.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "PcieNodeSlots": { "type": "array", "items": { "description": "Collection of PCI node slot identifiers where the GPU is connected.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "capability.GpuEndpointDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.GpuEndpointDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.GpuEndpointDescriptor' resources.", "x-one-of-name": "capability.GpuEndpointDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.GpuEndpointDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.GpuEndpointDescriptor": { "title": "Capability:Gpu Endpoint Descriptor", "description": "The capability.GpuEndpointDescriptor object is a descriptor used to uniquely identify a GPU (Graphics Processing Unit) within the capability catalog. It acts as a definitive inventory record for all supported GPU models.\n#### Purpose\nThe main purpose of this object is to maintain a catalog of GPU models, storing key identification information such as vendor, model, pid (Product ID), and partNumber. This catalog enables the system to validate installed GPUs, check their compatibility with specific server platforms, and provide accurate, detailed hardware inventory.\n#### Key Concepts\n- **GPU Cataloging:** Provides a structured repository for managing information about different GPU models.\n- **Unique Identification:** Uniquely defines each GPU type using a combination of vendor, model, and pid.\n- **Platform Compatibility:** The supportedPlatformsPids property links each GPU to the server platforms it is certified for, facilitating automated configuration checks.\n- **Read-Only Reference:** Serves as a source of truth for GPU specifications, used for system validation and inventory reporting.", "x-allOf-name": "capability.GpuEndpointDescriptor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.GpuEndpointDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.GpuEndpointDescriptor" ], "default": "capability.GpuEndpointDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.GpuEndpointDescriptor" ], "default": "capability.GpuEndpointDescriptor", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field is to provide model of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field is to provide partNumber of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field is to provide pid of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedPlatformsPids": { "type": "array", "items": { "description": "The platforms in which the gpu is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Vendor": { "description": "This field is to provide vendor of the gpu.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.GpuEndpointDescriptor.List": { "title": "List of 'capability.GpuEndpointDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.GpuEndpointDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.GpuEndpointDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.GpuEndpointDescriptor" }, "nullable": true } } } ] }, "capability.HardwareDescriptor": { "title": "Capability:Hardware Descriptor", "description": "Descriptor that uniquely identifies a hardware.", "x-allOf-name": "capability.HardwareDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.EndpointDescriptor" } ] }, "capability.HsuIsoFileSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.HsuIsoFileSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.HsuIsoFileSupportMeta' resources.", "x-one-of-name": "capability.HsuIsoFileSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.HsuIsoFileSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.HsuIsoFileSupportMeta": { "title": "Capability:Hsu Iso File Support Meta", "description": "Internal meta-data to check the HSU support to accept an iso file path in the upgrade request.", "x-allOf-name": "capability.HsuIsoFileSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.HsuIsoFileSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.HsuIsoFileSupportMeta" ], "default": "capability.HsuIsoFileSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.HsuIsoFileSupportMeta" ], "default": "capability.HsuIsoFileSupportMeta", "x-enum-as-string": true }, "DefaultFileName": { "description": "Name of the symbolic link to the actual iso file in the default case.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultMinVersion": { "description": "Firmware version from which the HSU capability is present in the default case.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModelSpecificConstraint": { "type": "array", "items": { "description": "Model-version specific combination for the hsu iso file support capability.", "$ref": "#/components/schemas/capability.HsuIsoModelSpecificConstraint", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Series": { "description": "Series name for the capability group.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.HsuIsoFileSupportMeta.List": { "title": "List of 'capability.HsuIsoFileSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.HsuIsoFileSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.HsuIsoFileSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.HsuIsoFileSupportMeta" }, "nullable": true } } } ] }, "capability.HsuIsoModelSpecificConstraint": { "title": "Capability:Hsu Iso Model Specific Constraint", "description": "Model-version combination for the hsu iso file support capability.", "x-allOf-name": "capability.HsuIsoModelSpecificConstraint", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.HsuIsoModelSpecificConstraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.HsuIsoModelSpecificConstraint" ], "default": "capability.HsuIsoModelSpecificConstraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.HsuIsoModelSpecificConstraint" ], "default": "capability.HsuIsoModelSpecificConstraint", "x-enum-as-string": true }, "FileName": { "description": "Name of the symbolic link to the actual iso file for this constraint.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinVersion": { "description": "The version below which the capability is not supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The server model this constraint is to be enforced upon.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.IoCardCapabilityDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.IoCardCapabilityDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.IoCardCapabilityDef' resources.", "x-one-of-name": "capability.IoCardCapabilityDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.IoCardCapabilityDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.IoCardCapabilityDef": { "title": "Capability:Io Card Capability Def", "description": "Chassis Iocard module capabilities.", "x-allOf-name": "capability.IoCardCapabilityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.IoCardCapabilityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.IoCardCapabilityDef" ], "default": "capability.IoCardCapabilityDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.IoCardCapabilityDef" ], "default": "capability.IoCardCapabilityDef", "x-enum-as-string": true }, "DcSupported": { "description": "Device connector support on Iocard.", "type": "boolean", "x-omitempty": true } } } ] }, "capability.IoCardCapabilityDef.List": { "title": "List of 'capability.IoCardCapabilityDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.IoCardCapabilityDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.IoCardCapabilityDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.IoCardCapabilityDef" }, "nullable": true } } } ] }, "capability.IoCardDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.IoCardDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.IoCardDescriptor' resources.", "x-one-of-name": "capability.IoCardDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.IoCardDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.IoCardDescriptor": { "title": "Capability:Io Card Descriptor", "description": "Descriptor that uniquely identifies an IO card module.", "x-allOf-name": "capability.IoCardDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.IoCardDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.IoCardDescriptor" ], "default": "capability.IoCardDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.IoCardDescriptor" ], "default": "capability.IoCardDescriptor", "x-enum-as-string": true }, "BifPortNum": { "description": "Identifies the bif port number for the iocard module.", "type": "integer", "format": "int64", "x-omitempty": true }, "IsUcsxDirectIoCard": { "description": "Identifies whether the iocard module is a part of the UCSX Direct chassis.", "type": "boolean", "default": false, "x-omitempty": true }, "NativeHifPortChannelRequired": { "description": "Identifies whether host port-channel is required to be configured for the iocard module.", "type": "boolean", "default": true, "x-omitempty": true }, "NativeSpeedMasterPortNum": { "description": "Primary port number for native speed configuration for the iocard module.", "type": "integer", "format": "int64", "x-omitempty": true }, "NumHifPorts": { "description": "Number of hif ports per blade for the iocard module.", "type": "integer", "format": "int64", "x-omitempty": true }, "Revision": { "description": "Revision for the iocard module.", "type": "string", "x-omitempty": true }, "UifConnectivity": { "description": "Connectivity information between UIF Uplink ports and IOM ports.\n* `inline` - UIF uplink ports and IOM ports are connected inline.\n* `cross-connected` - UIF uplink ports and IOM ports are cross-connected, a case in washington chassis.", "type": "string", "enum": [ "inline", "cross-connected" ], "default": "inline", "x-omitempty": true }, "UnsupportedPolicies": { "type": "array", "items": { "description": "Policies that are not applicable for Iocard.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "capability.IoCardDescriptor.List": { "title": "List of 'capability.IoCardDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.IoCardDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.IoCardDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.IoCardDescriptor" }, "nullable": true } } } ] }, "capability.IoCardManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.IoCardManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.IoCardManufacturingDef' resources.", "x-one-of-name": "capability.IoCardManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.IoCardManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.IoCardManufacturingDef": { "title": "Capability:Io Card Manufacturing Def", "description": "Chassis Iocard module properties.", "x-allOf-name": "capability.IoCardManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.IoCardManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.IoCardManufacturingDef" ], "default": "capability.IoCardManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.IoCardManufacturingDef" ], "default": "capability.IoCardManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for a chassis Iocard module.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for a chassis Iocard module.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a chassis Iocard module.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for IO Card Module.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for a chassis Iocard module.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for a chassis Iocard module.", "type": "string", "x-omitempty": true } } } ] }, "capability.IoCardManufacturingDef.List": { "title": "List of 'capability.IoCardManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.IoCardManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.IoCardManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.IoCardManufacturingDef" }, "nullable": true } } } ] }, "capability.IomUpgradeSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.IomUpgradeSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.IomUpgradeSupportMeta' resources.", "x-one-of-name": "capability.IomUpgradeSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.IomUpgradeSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.IomUpgradeSupportMeta": { "title": "Capability:Iom Upgrade Support Meta", "description": "Internal meta-data to enable IOM upgrade related decision making.", "x-allOf-name": "capability.IomUpgradeSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.IomUpgradeSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.IomUpgradeSupportMeta" ], "default": "capability.IomUpgradeSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.IomUpgradeSupportMeta" ], "default": "capability.IomUpgradeSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Information related to the list of IOMs. Also provides additional information such as hardware name.", "type": "string", "readOnly": true, "x-omitempty": true }, "DirectUpgrade": { "description": "Indicates if the IOM models have a Device Connector, which in turn allows direct upgrade requests to be sent to the IOM DC.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SeriesId": { "description": "Series names of IOMs which will be supported in the firmware operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of IOM models which fall under this series of IOM.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.IomUpgradeSupportMeta.List": { "title": "List of 'capability.IomUpgradeSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.IomUpgradeSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.IomUpgradeSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.IomUpgradeSupportMeta" }, "nullable": true } } } ] }, "capability.LdapBasePropertyConstraints": { "title": "Capability:Ldap Base Property Constraints", "description": "Constraints to be validated for LDAP policy.", "x-allOf-name": "capability.LdapBasePropertyConstraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.LdapBasePropertyConstraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.LdapBasePropertyConstraints" ], "default": "capability.LdapBasePropertyConstraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.LdapBasePropertyConstraints" ], "default": "capability.LdapBasePropertyConstraints", "x-enum-as-string": true }, "MaxLdapGroupsSupported": { "description": "Maximum LDAP groups supported in FI.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxLdapProvidersSupported": { "description": "Maximum LDAP providers supported in FI.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RolesSupported": { "type": "array", "items": { "description": "End point roles supported in this platform.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SupportedMaxLengthForDn": { "description": "Maximum length supported for distinguished name.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SupportedMaxLengthForFilter": { "description": "Maximum length supported for ldap search filter.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "capability.NetworkEquipmentPowerDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.NetworkEquipmentPowerDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.NetworkEquipmentPowerDef' resources.", "x-one-of-name": "capability.NetworkEquipmentPowerDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.NetworkEquipmentPowerDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.NetworkEquipmentPowerDef": { "title": "Capability:Network Equipment Power Def", "description": "Defines power requirements for equipment like Fabric Interconnects and FEX.\nUsed for Power Group power allocation calculations to determine the power\nconsumption for FI and FEX devices.", "x-allOf-name": "capability.NetworkEquipmentPowerDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.NetworkEquipmentPowerDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.NetworkEquipmentPowerDef" ], "default": "capability.NetworkEquipmentPowerDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.NetworkEquipmentPowerDef" ], "default": "capability.NetworkEquipmentPowerDef", "x-enum-as-string": true }, "DeviceType": { "description": "Device type - FabricInterconnect or Fex.\n* `Unknown` - The device type is unknown.\n* `FabricInterconnect` - The device is a Fabric Interconnect.\n* `Fex` - The device is a Fabric Extender (FEX).", "type": "string", "enum": [ "Unknown", "FabricInterconnect", "Fex" ], "default": "Unknown", "x-omitempty": true }, "MaxPower": { "description": "Maximum power consumption in watts.", "type": "integer", "format": "int64", "x-omitempty": true }, "Pid": { "description": "Product Identifier for the network equipment (e.g., UCS-FI-6454).", "type": "string", "x-omitempty": true }, "TypicalPower": { "description": "Typical power consumption in watts under normal operating conditions.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.NetworkEquipmentPowerDef.List": { "title": "List of 'capability.NetworkEquipmentPowerDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.NetworkEquipmentPowerDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.NetworkEquipmentPowerDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.NetworkEquipmentPowerDef" }, "nullable": true } } } ] }, "capability.PcIdRange": { "title": "Capability:Pc Id Range", "description": "Type to represent ranges of port-channel IDs supported.", "x-allOf-name": "capability.PcIdRange", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PcIdRange', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PcIdRange" ], "default": "capability.PcIdRange", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PcIdRange" ], "default": "capability.PcIdRange", "x-enum-as-string": true }, "EndPcId": { "description": "Ending Port-Channel ID in this range of port-channels.", "type": "integer", "format": "int64", "x-omitempty": true }, "StartPcId": { "description": "Starting Port-Channel ID in this range of port-channels.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.PolicyConstants.Response": { "description": "The response body of a HTTP GET request for the 'capability.PolicyConstants' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.PolicyConstants' resources.", "x-one-of-name": "capability.PolicyConstants.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.PolicyConstants.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.PolicyConstants": { "title": "Capability:Policy Constants", "description": "The PolicyConstants object is a specialized component within the capability catalog, designed to manage and aggregate validation rules for server policy properties. It serves as a centralized reference point for ensuring that server policies adhere to predefined standards and constraints, facilitating the consistent enforcement of management rules across the system.\n#### Purpose\nThe primary purpose of PolicyConstants is to provide a blueprint for policy validation. By aggregating specific rules and restrictions\u2014such as reserved keywords for device naming\u2014it ensures that server policies are configured correctly before they are applied. This centralized approach reduces configuration errors and maintains the integrity of server profiles and orchestration processes.\n#### Key Concepts\n- **Standardized Validation:** Acts as a repository for rules that govern how policy properties are defined, ensuring uniformity across different server configurations and policy types.\n- **Policy Integrity:** By enforcing restrictions on naming and parameters, it helps maintain the operational stability of critical system configurations, such as boot order policies.\n- **Capability Integration:** As an extension of the Capability object, it is part of a broader catalog of pre-defined server policy types, allowing it to be seamlessly integrated into the system's management framework.\n- **Role-Based Access:** Access to these constants is governed by a comprehensive set of privilege sets, ensuring that technical, administrative, and marketing roles have the appropriate level of visibility into policy constraints.", "x-allOf-name": "capability.PolicyConstants", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PolicyConstants', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PolicyConstants" ], "default": "capability.PolicyConstants", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PolicyConstants" ], "default": "capability.PolicyConstants", "x-enum-as-string": true }, "BootDeviceReservedKeywords": { "description": "List of reserved keywords for boot device policies.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.PolicyConstants.List": { "title": "List of 'capability.PolicyConstants' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.PolicyConstants' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.PolicyConstants' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.PolicyConstants" }, "nullable": true } } } ] }, "capability.PortGroupAggregationDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.PortGroupAggregationDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.PortGroupAggregationDef' resources.", "x-one-of-name": "capability.PortGroupAggregationDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.PortGroupAggregationDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.PortGroupAggregationDef": { "title": "Capability:Port Group Aggregation Def", "description": "The PortGroupAggregationDef defines how port-groups on FEX/IOCARD modules can be aggregated.\n#### Purpose\nA PortGroupAggregationDef serves as the blueprint for defining port group aggregation capabilities, supporting efficient network management and configuration. \n#### Key Concepts\n- **Aggregation Capability:** Specifies the aggregation capabilities associated with port groups, enhancing network efficiency and resource management.\n- **Module Integration:** Focuses on FEX/IOCARD module port groups, ensuring seamless integration and configuration within network systems.\n- **Access Management:** Utilizes privilege sets to ensure secure access and management of port group capabilities, maintaining system integrity.", "x-allOf-name": "capability.PortGroupAggregationDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PortGroupAggregationDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PortGroupAggregationDef" ], "default": "capability.PortGroupAggregationDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PortGroupAggregationDef" ], "default": "capability.PortGroupAggregationDef", "x-enum-as-string": true }, "AggregationCap": { "description": "Aggregation capability for port group.", "type": "string", "x-omitempty": true }, "Hw40GPortGroupCap": { "description": "Indicates support for 40G port group capability.", "type": "boolean", "x-omitempty": true }, "Pgtype": { "description": "The type of port group for which this capability is defined.", "type": "string", "x-omitempty": true } } } ] }, "capability.PortGroupAggregationDef.List": { "title": "List of 'capability.PortGroupAggregationDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.PortGroupAggregationDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.PortGroupAggregationDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.PortGroupAggregationDef" }, "nullable": true } } } ] }, "capability.PortPropertyConstraints": { "title": "Capability:Port Property Constraints", "description": "Constraints to be validated for Port policy.", "x-allOf-name": "capability.PortPropertyConstraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PortPropertyConstraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PortPropertyConstraints" ], "default": "capability.PortPropertyConstraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PortPropertyConstraints" ], "default": "capability.PortPropertyConstraints", "x-enum-as-string": true }, "LagSuspendIndividualPortSupported": { "description": "Indicates whether LAG suspend individual port setting is supported on this platform.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "MinBundleVersionFor25gSpeed": { "description": "Minimum bundle version required to support 25G speed on ports.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinSwitchVersionFor25gSpeed": { "description": "Minimum switch firmware version required to support 25G speed on ports.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.PortRange": { "title": "Capability:Port Range", "description": "Type to represent ranges of ports supporting certain speeds or features on a switch.", "x-allOf-name": "capability.PortRange", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PortRange', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PortRange" ], "default": "capability.PortRange", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PortRange" ], "default": "capability.PortRange", "x-enum-as-string": true }, "EndPortId": { "description": "Ending Port ID in this range of ports.", "type": "integer", "format": "int64", "x-omitempty": true }, "EndSlotId": { "description": "Ending Slot ID in this range of ports.", "type": "integer", "format": "int64", "x-omitempty": true }, "StartPortId": { "description": "Starting Port ID in this range of ports.", "type": "integer", "format": "int64", "x-omitempty": true }, "StartSlotId": { "description": "Starting Slot ID in this range of ports.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.ProcessorUnitUpdateConstraintMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.ProcessorUnitUpdateConstraintMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ProcessorUnitUpdateConstraintMeta' resources.", "x-one-of-name": "capability.ProcessorUnitUpdateConstraintMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ProcessorUnitUpdateConstraintMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ProcessorUnitUpdateConstraintMeta": { "title": "Capability:Processor Unit Update Constraint Meta", "description": "Internal meta-data to enable processor unit update related constraints.", "x-allOf-name": "capability.ProcessorUnitUpdateConstraintMeta", "allOf": [ { "$ref": "#/components/schemas/capability.UpdateConstraintMeta" } ] }, "capability.ProcessorUnitUpdateConstraintMeta.List": { "title": "List of 'capability.ProcessorUnitUpdateConstraintMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ProcessorUnitUpdateConstraintMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ProcessorUnitUpdateConstraintMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ProcessorUnitUpdateConstraintMeta" }, "nullable": true } } } ] }, "capability.PsuDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.PsuDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.PsuDescriptor' resources.", "x-one-of-name": "capability.PsuDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.PsuDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.PsuDescriptor": { "title": "Capability:Psu Descriptor", "description": "The capability.PsuDescriptor object is a hardware descriptor that uniquely identifies a Power Supply Unit (PSU) within the capability catalog. It serves as a reference record for specific models of PSUs.\n#### Purpose\nThe purpose of this object is to maintain a catalog of known PSU models. By capturing key identifiers like vendor, model, version, and revision, it allows the system to validate the PSUs installed in a server or chassis. This ensures that the components are recognized, supported, and compatible with the equipment they are installed in.\n#### Key Concepts\n- **Hardware Cataloging:** Provides a structured entry for a specific PSU model in the system's hardware catalog.\n- **Unique Identification:** Uses a composite key of vendor, model, version, and revision to uniquely identify a PSU type.\n- **Component Validation:** Enables the system to verify that the PSUs discovered in a device match the known, supported hardware definitions.\n- **Extensible Framework:** As a HardwareDescriptor, it is part of an extensible catalog that can be updated with new PSU models as they become available.", "x-allOf-name": "capability.PsuDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PsuDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PsuDescriptor" ], "default": "capability.PsuDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PsuDescriptor" ], "default": "capability.PsuDescriptor", "x-enum-as-string": true }, "Revision": { "description": "Revision for the power supply.", "type": "string", "x-omitempty": true } } } ] }, "capability.PsuDescriptor.List": { "title": "List of 'capability.PsuDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.PsuDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.PsuDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.PsuDescriptor" }, "nullable": true } } } ] }, "capability.PsuManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.PsuManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.PsuManufacturingDef' resources.", "x-one-of-name": "capability.PsuManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.PsuManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.PsuManufacturingDef": { "title": "Capability:Psu Manufacturing Def", "description": "The capability.PsuManufacturingDef object is a capability definition that stores manufacturing-specific details for a Power Supply Unit (PSU). This provides a comprehensive set of identifiers for product and inventory management.\n#### Purpose\nThis object's primary function is to act as a reference for the manufacturing details of a PSU. It aggregates key product identifiers such as pid (Product Identifier), vid (Vendor ID), sku (Stock Keeping Unit), and productName. This information is essential for accurate inventory, asset tracking, and integration with support and ordering systems.\n#### Key Concepts\n- **Manufacturing Reference:** Centralizes key manufacturing and product data for a specific PSU model.\n- **Product Identification:** Provides standard identifiers (pid, sku, productName) that allow for easy lookup and correlation with external product databases.\n- **Descriptive Data:** Includes a caption and description to offer human-readable context about the PSU.\n- **Capability Catalog Entry:** Serves as a definition within the capability catalog, which can be referenced by other objects to retrieve detailed manufacturing information.", "x-allOf-name": "capability.PsuManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.PsuManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.PsuManufacturingDef" ], "default": "capability.PsuManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.PsuManufacturingDef" ], "default": "capability.PsuManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for a power supply unit.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for a power supply unit.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a power supply unit.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for Power Supplu Unit.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for a power supply unit.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for a power supply unit.", "type": "string", "x-omitempty": true } } } ] }, "capability.PsuManufacturingDef.List": { "title": "List of 'capability.PsuManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.PsuManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.PsuManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.PsuManufacturingDef" }, "nullable": true } } } ] }, "capability.ServerActionsMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerActionsMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerActionsMeta' resources.", "x-one-of-name": "capability.ServerActionsMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerActionsMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerActionsMeta": { "title": "Capability:Server Actions Meta", "description": "The ServerActionsMeta object plays an integral role in enabling Host Server Utility (HSU) actions within Cisco's Intersight platform. This provides internal metadata necessary to support specific server operations.\n#### Purpose\nServerActionsMeta is designed to support and manage HSU-related actions, ensuring that operations are executed correctly within the constraints defined. It helps streamline server management tasks by providing essential metadata for action validation.\n#### Key Concepts\n- **Support for HSU Actions:** Encapsulates necessary information to enable server actions related to Host Server Utility.\n- **Privilege Sets:** Establishes access levels required for executing read, update, and delete operations.\n- **Target Validation:** Contains properties that aid in the validation of actions, ensuring that operations are performed on compatible server models and firmware versions.\n- ** Efficiency:** Enhances operational efficiency by providing metadata that supports streamlined server management.", "x-allOf-name": "capability.ServerActionsMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerActionsMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerActionsMeta" ], "default": "capability.ServerActionsMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerActionsMeta" ], "default": "capability.ServerActionsMeta", "x-enum-as-string": true }, "ActionName": { "description": "Action which will be supported using the HSU.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinSupportedVersion": { "description": "Firmware version below which host operation is not supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetType": { "description": "The target type to which the metadata applies.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "readOnly": true, "x-omitempty": true } } } ] }, "capability.ServerActionsMeta.List": { "title": "List of 'capability.ServerActionsMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerActionsMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerActionsMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerActionsMeta" }, "nullable": true } } } ] }, "capability.ServerComponentConstraint": { "title": "Capability:Server Component Constraint", "description": "Constitutes the server model specific version support for the associated component.", "x-allOf-name": "capability.ServerComponentConstraint", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerComponentConstraint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerComponentConstraint" ], "default": "capability.ServerComponentConstraint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerComponentConstraint" ], "default": "capability.ServerComponentConstraint", "x-enum-as-string": true }, "MinSupportedVersion": { "description": "The version below which the component is not supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerModel": { "description": "The server model this constraint is to be enforced upon.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.ServerDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerDescriptor' resources.", "x-one-of-name": "capability.ServerDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerDescriptor": { "title": "Capability:Server Descriptor", "description": "The capability.ServerDescriptor object is a hardware descriptor that uniquely identifies an Intersight Managed Mode (IMM) server model and defines its specific capabilities and characteristics.\n#### Purpose\nThe ServerDescriptor object serves as a central point in the capability catalog for defining model-specific server attributes. It allows the system to understand the unique features, limitations, and default configurations of a particular server model, such as UCSB-B200-M5. It is crucial for applying correct policies, enabling or disabling features, and ensuring proper management.\n#### Key Concepts\n- **Model-Specific Capabilities:** Defines attributes that are specific to a server model, such as whether the NCSI side-band interface is enabled (isNcsiEnabled) or the default PCIe slot for an MLOM adapter (mlomAdapterPcieSlotNumber).\n- **Policy Applicability:** The unsupportedPolicies property lists policies that are not applicable to a specific server model, preventing misconfiguration.\n- **Form Factor Identification:** Specifies the server's physical form factor (serverFormFactor), such as \"blade\" or \"rack\" which influences management logic.\n- **Unique Identification:** Uniquely identifies a server capability profile by its vendor and model.", "x-allOf-name": "capability.ServerDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerDescriptor" ], "default": "capability.ServerDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerDescriptor" ], "default": "capability.ServerDescriptor", "x-enum-as-string": true }, "IsNcsiEnabled": { "description": "Indicates whether the CIMC to VIC side-band interface is enabled on the server.", "type": "boolean", "x-omitempty": true }, "IsPplEnabled": { "description": "Indicates Processor Package Power Limit for the server.", "type": "boolean", "default": false, "x-omitempty": true }, "MlomAdapterPcieSlotNumber": { "description": "Indicates PCIe Slot numerical value for each Server model MLOM slot.", "type": "integer", "format": "int64", "x-omitempty": true }, "ServerFormFactor": { "description": "The form factor (blade/rack/etc) of the server.\n* `unknown` - The form factor of the server is unknown.\n* `blade` - Blade server form factor.\n* `rack` - Rack unit server form factor.", "type": "string", "enum": [ "unknown", "blade", "rack" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "SupportedPolicies": { "type": "array", "items": { "description": "Policies that are applicable on C8XX server model.", "type": "string", "x-omitempty": true }, "nullable": true }, "UnsupportedPolicies": { "type": "array", "items": { "description": "Policies that are not applicable on avatar server for a certain model.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "capability.ServerDescriptor.List": { "title": "List of 'capability.ServerDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerDescriptor" }, "nullable": true } } } ] }, "capability.ServerModelsCapabilityDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerModelsCapabilityDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerModelsCapabilityDef' resources.", "x-one-of-name": "capability.ServerModelsCapabilityDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerModelsCapabilityDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerModelsCapabilityDef": { "title": "Capability:Server Models Capability Def", "description": "Used to categorize server models.", "x-allOf-name": "capability.ServerModelsCapabilityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerModelsCapabilityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerModelsCapabilityDef" ], "default": "capability.ServerModelsCapabilityDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerModelsCapabilityDef" ], "default": "capability.ServerModelsCapabilityDef", "x-enum-as-string": true }, "Models": { "type": "array", "items": { "description": "List of models which fall under this category.", "type": "string", "x-omitempty": true }, "nullable": true }, "ServerType": { "description": "Type of the server. Example, BladeM6, RackM5.", "type": "string", "x-omitempty": true } } } ] }, "capability.ServerModelsCapabilityDef.List": { "title": "List of 'capability.ServerModelsCapabilityDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerModelsCapabilityDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerModelsCapabilityDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerModelsCapabilityDef" }, "nullable": true } } } ] }, "capability.ServerPcieConnectivityCatalog.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerPcieConnectivityCatalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerPcieConnectivityCatalog' resources.", "x-one-of-name": "capability.ServerPcieConnectivityCatalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerPcieConnectivityCatalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerPcieConnectivityCatalog": { "title": "Server PCIe connectivity catalog", "description": "Catalog of supported physical connectivity layouts from server to PCIe devices for topology validation.", "x-allOf-name": "capability.ServerPcieConnectivityCatalog", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerPcieConnectivityCatalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerPcieConnectivityCatalog" ], "default": "capability.ServerPcieConnectivityCatalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerPcieConnectivityCatalog" ], "default": "capability.ServerPcieConnectivityCatalog", "x-enum-as-string": true }, "SupportedLayouts": { "type": "array", "items": { "description": "Collection of predefined physical connectivity topologies that define valid server-to-PCIe device connections.", "$ref": "#/components/schemas/capability.ServerPcieConnectivityLayout", "x-omitempty": true }, "nullable": true }, "SupportedNumberOfGpus": { "type": "array", "items": { "description": "Supported number of GPUs to server.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "capability.ServerPcieConnectivityCatalog.List": { "title": "List of 'capability.ServerPcieConnectivityCatalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerPcieConnectivityCatalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerPcieConnectivityCatalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerPcieConnectivityCatalog" }, "nullable": true } } } ] }, "capability.ServerPcieConnectivityLayout": { "title": "Server PCIe connectivity layout", "description": "Complete physical connectivity layout from server CPU to PCIe devices for topology validation.", "x-allOf-name": "capability.ServerPcieConnectivityLayout", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerPcieConnectivityLayout', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerPcieConnectivityLayout" ], "default": "capability.ServerPcieConnectivityLayout", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerPcieConnectivityLayout" ], "default": "capability.ServerPcieConnectivityLayout", "x-enum-as-string": true }, "CpuId": { "description": "Unique identifier for the server CPU in the physical connection topology.", "type": "integer", "format": "int64", "x-omitempty": true }, "PcieTopology": { "type": "array", "items": { "description": "Collection of physical PCIe topology connections from server to devices.", "$ref": "#/components/schemas/capability.ServerPcieTopology", "x-omitempty": true }, "nullable": true }, "ServerSlots": { "type": "array", "items": { "description": "Collection of server slot numbers associated with this CPU topology.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true } } } ] }, "capability.ServerPcieTopology": { "title": "Server PCIe topology", "description": "Physical topology mapping of PCIe connections within the server infrastructure.", "x-allOf-name": "capability.ServerPcieTopology", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerPcieTopology', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerPcieTopology" ], "default": "capability.ServerPcieTopology", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerPcieTopology" ], "default": "capability.ServerPcieTopology", "x-enum-as-string": true }, "ConnectedAdapter": { "type": "array", "items": { "description": "Collection of Smart NIC devices connected through this PCIe switch.", "$ref": "#/components/schemas/capability.AdapterConnectionPoint", "x-omitempty": true }, "nullable": true }, "ConnectedGpu": { "type": "array", "items": { "description": "Collection of GPU devices connected through this PCIe switch.", "$ref": "#/components/schemas/capability.GpuConnectionPoint", "x-omitempty": true }, "nullable": true }, "PcieSwitchId": { "description": "Unique identifier for the physical PCIe switch in the server topology.", "type": "integer", "format": "int64", "x-omitempty": true }, "XfmId": { "description": "Unique identifier for the XFM (Switch Fabric Module) in the server topology.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.ServerSchemaDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerSchemaDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerSchemaDescriptor' resources.", "x-one-of-name": "capability.ServerSchemaDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerSchemaDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerSchemaDescriptor": { "title": "Capability:Server Schema Descriptor", "description": "The capability.ServerSchemaDescriptor is a hardware descriptor that identifies a server's Redfish capability for specific actions, such as controlling the locator LED, based on its CIMC firmware and Redfish schema version.\n#### Purpose\nThe primary purpose of this object is to create a mapping between a server's firmware version and the specific Redfish properties used to control certain hardware features. For example, it defines the correct locatorLedName property to use for toggling the locator LED, which can vary between different Redfish schema versions. This allows for consistent management actions across a diverse range of server firmware.\n#### Key Concepts\n- **Redfish Capability Mapping:** Links server hardware actions to specific Redfish schema properties (redfishSchema, locatorLedName).\n- **Firmware-Dependent Logic:** The descriptor is identified by vendor, model, and version, making the mapping dependent on the server's firmware.\n- **Action Abstraction:** Allows the management system to use a consistent action (e.g., \"turn on locator LED\") while the descriptor provides the specific implementation detail for the target server.\n- **Extensible Catalog:** As a HardwareDescriptor, it is part of a catalog that can be updated to support new server models and Redfish schema versions without changing core management logic.", "x-allOf-name": "capability.ServerSchemaDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerSchemaDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerSchemaDescriptor" ], "default": "capability.ServerSchemaDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerSchemaDescriptor" ], "default": "capability.ServerSchemaDescriptor", "x-enum-as-string": true }, "LocatorLedName": { "description": "Redfish property name for the server.", "type": "string", "x-omitempty": true }, "RedfishSchema": { "description": "Redfish version information for the server.", "type": "string", "x-omitempty": true } } } ] }, "capability.ServerSchemaDescriptor.List": { "title": "List of 'capability.ServerSchemaDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerSchemaDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerSchemaDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerSchemaDescriptor" }, "nullable": true } } } ] }, "capability.ServerTopologyMap.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerTopologyMap' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerTopologyMap' resources.", "x-one-of-name": "capability.ServerTopologyMap.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerTopologyMap.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerTopologyMap": { "title": "Server topology map", "description": "Mapping of server models to their supported PCIe topology configurations and compatibility matrix.", "x-allOf-name": "capability.ServerTopologyMap", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerTopologyMap', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerTopologyMap" ], "default": "capability.ServerTopologyMap", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerTopologyMap" ], "default": "capability.ServerTopologyMap", "x-enum-as-string": true }, "Handler": { "description": "Handler identifier for managing this topology configuration.", "type": "string", "x-omitempty": true }, "PcieNodeDetail": { "description": "PCIe node model information for this topology configuration.", "$ref": "#/components/schemas/capability.DeviceInventory", "x-omitempty": true }, "ServerDetail": { "description": "Server model information for which this topology configuration is defined.", "$ref": "#/components/schemas/capability.DeviceInventory", "x-omitempty": true }, "SupportedTopologyName": { "description": "Server model information for which this topology configuration is defined.", "type": "string", "x-omitempty": true }, "XfmDetail": { "description": "XFM (Switch Fabric Module) model information for this topology configuration.", "$ref": "#/components/schemas/capability.DeviceInventory", "x-omitempty": true } } } ] }, "capability.ServerTopologyMap.List": { "title": "List of 'capability.ServerTopologyMap' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerTopologyMap' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerTopologyMap' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerTopologyMap" }, "nullable": true } } } ] }, "capability.ServerUpgradeSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.ServerUpgradeSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.ServerUpgradeSupportMeta' resources.", "x-one-of-name": "capability.ServerUpgradeSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.ServerUpgradeSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.ServerUpgradeSupportMeta": { "title": "Capability:Server Upgrade Support Meta", "description": "Internal meta-data to map server family classification from server model, used in f/w policy also.", "x-allOf-name": "capability.ServerUpgradeSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.ServerUpgradeSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.ServerUpgradeSupportMeta" ], "default": "capability.ServerUpgradeSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.ServerUpgradeSupportMeta" ], "default": "capability.ServerUpgradeSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Verbose description regarding this group of server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Platform": { "description": "The target platform for which the mapping is defined.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerFamily": { "description": "Classification of a set of server models.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of chassis models which belong to this series.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.ServerUpgradeSupportMeta.List": { "title": "List of 'capability.ServerUpgradeSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.ServerUpgradeSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.ServerUpgradeSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.ServerUpgradeSupportMeta" }, "nullable": true } } } ] }, "capability.SiocModuleCapabilityDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.SiocModuleCapabilityDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SiocModuleCapabilityDef' resources.", "x-one-of-name": "capability.SiocModuleCapabilityDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SiocModuleCapabilityDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SiocModuleCapabilityDef": { "title": "Capability:Sioc Module Capability Def", "description": "Chassis SIOC module capabilities.", "x-allOf-name": "capability.SiocModuleCapabilityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SiocModuleCapabilityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SiocModuleCapabilityDef" ], "default": "capability.SiocModuleCapabilityDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SiocModuleCapabilityDef" ], "default": "capability.SiocModuleCapabilityDef", "x-enum-as-string": true }, "DcSupported": { "description": "Device connector support on SIOC.", "type": "boolean", "x-omitempty": true } } } ] }, "capability.SiocModuleCapabilityDef.List": { "title": "List of 'capability.SiocModuleCapabilityDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SiocModuleCapabilityDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SiocModuleCapabilityDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SiocModuleCapabilityDef" }, "nullable": true } } } ] }, "capability.SiocModuleDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.SiocModuleDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SiocModuleDescriptor' resources.", "x-one-of-name": "capability.SiocModuleDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SiocModuleDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SiocModuleDescriptor": { "title": "Capability:Sioc Module Descriptor", "description": "Descriptor that uniquely identifies an SIOC module.", "x-allOf-name": "capability.SiocModuleDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SiocModuleDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SiocModuleDescriptor" ], "default": "capability.SiocModuleDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SiocModuleDescriptor" ], "default": "capability.SiocModuleDescriptor", "x-enum-as-string": true }, "Revision": { "description": "Revision for the SIOC module.", "type": "string", "x-omitempty": true } } } ] }, "capability.SiocModuleDescriptor.List": { "title": "List of 'capability.SiocModuleDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SiocModuleDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SiocModuleDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SiocModuleDescriptor" }, "nullable": true } } } ] }, "capability.SiocModuleManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.SiocModuleManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SiocModuleManufacturingDef' resources.", "x-one-of-name": "capability.SiocModuleManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SiocModuleManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SiocModuleManufacturingDef": { "title": "Capability:Sioc Module Manufacturing Def", "description": "Chassis SIOC module properties.", "x-allOf-name": "capability.SiocModuleManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SiocModuleManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SiocModuleManufacturingDef" ], "default": "capability.SiocModuleManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SiocModuleManufacturingDef" ], "default": "capability.SiocModuleManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for a chassis SIOC module.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for a chassis SIOC module.", "type": "string", "x-omitempty": true }, "Pid": { "description": "Product Identifier for a chassis SIOC module.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for SIOC Module.", "type": "string", "x-omitempty": true }, "Sku": { "description": "SKU information for a chassis SIOC module.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for a chassis SIOC module.", "type": "string", "x-omitempty": true } } } ] }, "capability.SiocModuleManufacturingDef.List": { "title": "List of 'capability.SiocModuleManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SiocModuleManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SiocModuleManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SiocModuleManufacturingDef" }, "nullable": true } } } ] }, "capability.StandardRedfishSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.StandardRedfishSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.StandardRedfishSupportMeta' resources.", "x-one-of-name": "capability.StandardRedfishSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.StandardRedfishSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.StandardRedfishSupportMeta": { "title": "Capability:Standard Redfish Support Meta", "description": "Internal meta-data to check standard redfish support by Platform type.", "x-allOf-name": "capability.StandardRedfishSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.StandardRedfishSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.StandardRedfishSupportMeta" ], "default": "capability.StandardRedfishSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.StandardRedfishSupportMeta" ], "default": "capability.StandardRedfishSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Verbose description regarding this group of platform.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "type": "array", "items": { "description": "List of platform types which have support for redfish SimpleUpdate.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SeriesId": { "description": "Classification of a set of server platform type.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.StandardRedfishSupportMeta.List": { "title": "List of 'capability.StandardRedfishSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.StandardRedfishSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.StandardRedfishSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.StandardRedfishSupportMeta" }, "nullable": true } } } ] }, "capability.StorageControllerUpdateConstraintMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.StorageControllerUpdateConstraintMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.StorageControllerUpdateConstraintMeta' resources.", "x-one-of-name": "capability.StorageControllerUpdateConstraintMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.StorageControllerUpdateConstraintMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.StorageControllerUpdateConstraintMeta": { "title": "Capability:Storage Controller Update Constraint Meta", "description": "Internal meta-data to enable storage controller update related constraints.", "x-allOf-name": "capability.StorageControllerUpdateConstraintMeta", "allOf": [ { "$ref": "#/components/schemas/capability.UpdateConstraintMeta" } ] }, "capability.StorageControllerUpdateConstraintMeta.List": { "title": "List of 'capability.StorageControllerUpdateConstraintMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.StorageControllerUpdateConstraintMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.StorageControllerUpdateConstraintMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.StorageControllerUpdateConstraintMeta" }, "nullable": true } } } ] }, "capability.StorageControllersMetaData.Response": { "description": "The response body of a HTTP GET request for the 'capability.StorageControllersMetaData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.StorageControllersMetaData' resources.", "x-one-of-name": "capability.StorageControllersMetaData.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.StorageControllersMetaData.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.StorageControllersMetaData": { "title": "Capability:Storage Controllers Meta Data", "description": "The capability.StorageControllersMetaData object provides metadata and constraints for actions related to storage controllers on a server. It defines which storage management actions are supported for a specific combination of server and controller hardware.\n#### Purpose\nThe main function of this object is to act as a validation gate for storage operations. Before an action (like creating a virtual drive or configuring a drive security policy) is performed, the system checks this metadata to ensure the action is supported on the target server's specific storage controller. This prevents unsupported operations and ensures configuration integrity.\n#### Key Concepts\n- **Action Validation:** Defines the set of supportedStorageServerActions for a given controller, enabling pre-flight checks for storage management tasks.\n- **Hardware-Specific Constraints:** The metadata is tied to a specific targetType (server platform) and controllerPid (controller model), ensuring granular control.\n- **Feature Support Indication:** Includes flags like isHybridDriveSlotsSupported to indicate whether specific hardware features are available on the controller.\n- ** Centralized Capability Catalog:** Serves as a single source of truth for storage controller capabilities, simplifying management logic and ensuring consistency.", "x-allOf-name": "capability.StorageControllersMetaData", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.StorageControllersMetaData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.StorageControllersMetaData" ], "default": "capability.StorageControllersMetaData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.StorageControllersMetaData" ], "default": "capability.StorageControllersMetaData", "x-enum-as-string": true }, "ControllerPid": { "description": "The controller Pid to which the metadata applies.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerSeries": { "description": "Product family of the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerType": { "description": "Type of the controller. Expected values are Hba, RAID etc.\n* `Unknown` - Storage controller type is not known.\n* `Hba` - The Hba type of storage controller.\n* `Raid` - The Raid type of storage controller.", "type": "string", "enum": [ "Unknown", "Hba", "Raid" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ControllerVendor": { "description": "Manufacturer of the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsHybridDriveSlotsSupported": { "description": "Controller supports HybridDriveslots.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SupportedStorageServerActions": { "type": "array", "items": { "description": "Set of actions supported for a particular server model.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetType": { "description": "The target type to which the metadata applies.\n* `` - An unrecognized platform type.\n* `APIC` - A Cisco Application Policy Infrastructure Controller (APIC) cluster.\n* `CAPIC` - A Cisco Cloud Application Policy Infrastructure Controller (Cloud APIC) instance.\n* `DCNM` - A Cisco Data Center Network Manager (DCNM) instance.\n* `UCSFI` - A Cisco UCS Fabric Interconnect that is managed by Cisco UCS Manager (UCSM).\n* `UCSFIISM` - A Cisco UCS Fabric Interconnect that is managed by Cisco Intersight.\n* `IMC` - A standalone Cisco UCS rack server (Deprecated).\n* `IMCM4` - A standalone Cisco UCS C-Series or S-Series M4 server.\n* `IMCM5` - A standalone Cisco UCS C-Series or S-Series M5 server.\n* `IMCRack` - A standalone Cisco UCS C-Series or S-Series M6 or newer server.\n* `UCSIOM` - A Cisco UCS Blade Chassis I/O Module (IOM).\n* `UCSPCIeNODE` - A Cisco UCS PCIe Node in a blade form factor.\n* `UCSXFM` - A Cisco UCS Fabric Extender Module (XFM).\n* `HX` - A Cisco HyperFlex (HX) cluster.\n* `UCSD` - A Cisco UCS Director (UCSD) instance.\n* `UCSXECMC` - A Cisco UCSXE Chassis Management Controller.\n* `UCSXESecureRouter` - A secure networking router node designed to operate as part of a UCSXE chassis.\n* `IntersightAppliance` - A Cisco Intersight Connected Virtual Appliance instance.\n* `IntersightAssist` - A Cisco Intersight Assist instance.\n* `PureStorageFlashArray` - A Pure Storage FlashArray that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and storage management features are supported on this device.\n* `PureStorageFlashBladeSystem` - A Pure Storage FlashBlade target that is managed using Cisco Intersight Assist. Storage management feature is supported on this device.\n* `NexusDevice` - A Cisco Nexus Network Switch that is managed using Cisco Intersight Assist.\n* `ACISwitch` - A Cisco Nexus Network Switch with the embedded Device Connector and is a part of the Cisco ACI fabric.\n* `NexusSwitch` - A standalone Cisco Nexus Network Switch with the embedded Device Connector.\n* `MDSSwitch` - A Cisco MDS Switch that is managed using the embedded Device Connector.\n* `MDSDevice` - A Cisco MDS Switch that is managed using Cisco Intersight Assist.\n* `UCSC885` - A standalone Cisco UCS C885 Server.\n* `CAI845A` - A standalone Cisco AI 845A Server.\n* `UCSC890` - A standalone Cisco UCS C890 server managed using Cisco Intersight Assist.\n* `RedfishServer` - A generic target type for servers that support Redfish APIs and is managed using Cisco Intersight Assist. Support is limited to HPE and Dell Servers.\n* `NetAppOntap` - A Netapp ONTAP Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `NetAppActiveIqUnifiedManager` - A NetApp Active IQ Unified Manager (AIQUM) that is managed using Cisco Intersight Assist.\n* `EmcScaleIo` - An EMC ScaleIO Software Defined Storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVmax` - An EMC VMAX 2 or 3 series enterprise storage array that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcVplex` - An EMC VPLEX virtual storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `EmcXtremIo` - An EMC XtremIO SSD storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `VmwareVcenter` - A VMware vCenter instance that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer and Virtualization features are supported on this hypervisor.\n* `MicrosoftHyperV` - A Microsoft Hyper-V host that is managed using Cisco Intersight Assist. Optionally, other hosts in the cluster can be discovered through this host. Cisco Intersight Workload Optimizer features are supported on this hypervisor.\n* `AppDynamics` - An AppDynamics controller running in a SaaS or on-prem datacenter. On-prem AppDynamics instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this controller.\n* `Dynatrace` - A Dynatrace Server instance running in a SaaS or on-prem datacenter. On-prem Dynatrace instance is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `NewRelic` - A NewRelic user account. The NewRelic instance monitors the application infrastructure. Cisco Intersight Workload Optimizer features are supported on this server.\n* `ServiceNow` - A cloud-based workflow automation platform that enables enterprise organizations to improve operational efficiencies by streamlining and automating routine work tasks.\n* `Umbrella` - Umbrella cloud target that discovers and monitors an organization. It discovers entities like Datacenters, Devices, Tunnels, Networks, etc.\n* `CloudFoundry` - An open source cloud platform on which developers can build, deploy, run and scale applications.\n* `MicrosoftAzureApplicationInsights` - A feature of Azure Monitor, is an extensible Application Performance Management service for developers and DevOps professionals to monitor their live applications.\n* `OpenStack` - An OpenStack target manages Virtual Machines, Physical Machines, Datacenters and Virtual Datacenters using different OpenStack services as administrative endpoints.\n* `MicrosoftSqlServer` - A Microsoft SQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `MySqlServer` - A MySQL database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `OracleDatabaseServer` - An Oracle database server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this database.\n* `IBMWebSphereApplicationServer` - An IBM WebSphere Application server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application server.\n* `OracleWebLogicServer` - Oracle WebLogic Server is a unified and extensible platform for developing, deploying and running enterprise applications, such as Java, for on-premises and in the cloud. WebLogic Server offers a robust, mature, and scalable implementation of Java Enterprise Edition (EE) and Jakarta EE.\n* `ApacheTomcatServer` - An Apache Tomcat server that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this server.\n* `JavaVirtualMachine` - A JVM Application with JMX configured that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this application.\n* `RedHatJBossApplicationServer` - JBoss Application Server is an open-source, cross-platform Java application server developed by JBoss, a division of Red Hat Inc. It is an open-source implementation of Java 2 Enterprise Edition (J2EE) that is used for implementing Java applications and other Web-based applications and software.\n* `Kubernetes` - A Kubernetes cluster that runs containerized applications, with Kubernetes Collector installed. Cisco Intersight Workload Optimizer features are supported on Kubernetes cluster.\n* `AmazonWebService` - An Amazon Web Service cloud account. Cisco Intersight Workload Optimizer and Virtualization features are supported on this cloud.\n* `AmazonWebServiceBilling` - An Amazon Web Service cloud billing account used to retrieve billing information stored in S3 bucket. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatform` - A Google Cloud Platform service account with access to one or more projects. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `GoogleCloudPlatformBilling` - A Google Cloud Platform service account used to retrieve billing information from BigQuery. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureServicePrincipal` - A Microsoft Azure Service Principal account with access to Azure subscriptions. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureEnterpriseAgreement` - A Microsoft Azure Enterprise Agreement enrolment used to retrieve pricing and billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `MicrosoftAzureBilling` - A Microsoft Azure Service Principal account with access to billing information. Cisco Intersight Workload Optimizer features are supported on this cloud.\n* `DellCompellent` - A Dell EMC SC Series (Compellent) storage system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `HPE3Par` - A HPE 3PAR StoreServ system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this device.\n* `RedHatEnterpriseVirtualization` - A Red Hat Enterprise Virtualization Hypervisor system that manages Virtual Machines.\n* `NutanixAcropolis` - A Nutanix Acropolis cluster that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this cluster.\n* `NutanixPrismCentral` - A Nutanix Prism Central cluster. Prism central is a virtual appliance for managing Nutanix clusters and services.\n* `HPEOneView` - A HPE OneView system that is managed using Cisco Intersight Assist. Cisco Intersight Workload Optimizer features are supported on this system.\n* `ServiceEngine` - Cisco Application Services Engine. Cisco Application Services Engine is a platform to deploy and manage applications.\n* `HitachiVirtualStoragePlatform` - A Hitachi Virtual Storage Platform (Hitachi VSP) that is managed using Cisco Intersight Assist.\n* `GenericTarget` - A generic third-party target supported only in Partner Integration Appliance. This target type is used for development purposes and will not be supported in production environment.\n* `IMCBlade` - A Cisco UCS blade server managed by Cisco Intersight.\n* `TerraformCloud` - A Terraform Cloud Business Tier account.\n* `TerraformAgent` - A Terraform Cloud Agent that will be deployed on Cisco Intersight Assist. The agent can be used to plan and apply Terraform runs from a Terraform Cloud workspace.\n* `CustomTarget` - CustomTarget is deprecated. Use HTTPEndpoint type to claim HTTP endpoints.\n* `AnsibleEndpoint` - An external endpoint that is added as a target which can be accessed through Ansible in Intersight Cloud Orchestrator automation workflows.\n* `HTTPEndpoint` - An HTTP endpoint that can be accessed in Intersight Orchestrator workflows directly or using Cisco Intersight Assist. Authentication Schemes supported are Basic and Bearer Token.\n* `SSHEndpoint` - An SSH endpoint that can be accessed in Intersight Orchestrator workflows using Cisco Intersight Assist.\n* `CiscoCatalyst` - A Cisco Catalyst networking switch device.\n* `PowerShellEndpoint` - A Windows operating system server on which PowerShell scripts can be executed using Cisco Intersight Assist.\n* `CiscoDNAC` - A Cisco Digital Network Architecture (DNA) Center appliance.\n* `CiscoFMC` - A Cisco Secure Firewall Management Center.\n* `ViptelaCloud` - ViptelaCloud is deprecated. Use CatalystSDWANManager type to claim Catalyst SDWAN Manager which can manage Catalyst SDWAN devices.\n* `CatalystSDWANManager` - A Cisco Catalyst SD-WAN Manager.\n* `MerakiCloud` - A Cisco Meraki Organization.\n* `CiscoISE` - A Cisco Identity Services Engine (ISE) target.", "type": "string", "enum": [ "", "APIC", "CAPIC", "DCNM", "UCSFI", "UCSFIISM", "IMC", "IMCM4", "IMCM5", "IMCRack", "UCSIOM", "UCSPCIeNODE", "UCSXFM", "HX", "UCSD", "UCSXECMC", "UCSXESecureRouter", "IntersightAppliance", "IntersightAssist", "PureStorageFlashArray", "PureStorageFlashBladeSystem", "NexusDevice", "ACISwitch", "NexusSwitch", "MDSSwitch", "MDSDevice", "UCSC885", "CAI845A", "UCSC890", "RedfishServer", "NetAppOntap", "NetAppActiveIqUnifiedManager", "EmcScaleIo", "EmcVmax", "EmcVplex", "EmcXtremIo", "VmwareVcenter", "MicrosoftHyperV", "AppDynamics", "Dynatrace", "NewRelic", "ServiceNow", "Umbrella", "CloudFoundry", "MicrosoftAzureApplicationInsights", "OpenStack", "MicrosoftSqlServer", "MySqlServer", "OracleDatabaseServer", "IBMWebSphereApplicationServer", "OracleWebLogicServer", "ApacheTomcatServer", "JavaVirtualMachine", "RedHatJBossApplicationServer", "Kubernetes", "AmazonWebService", "AmazonWebServiceBilling", "GoogleCloudPlatform", "GoogleCloudPlatformBilling", "MicrosoftAzureServicePrincipal", "MicrosoftAzureEnterpriseAgreement", "MicrosoftAzureBilling", "DellCompellent", "HPE3Par", "RedHatEnterpriseVirtualization", "NutanixAcropolis", "NutanixPrismCentral", "HPEOneView", "ServiceEngine", "HitachiVirtualStoragePlatform", "GenericTarget", "IMCBlade", "TerraformCloud", "TerraformAgent", "CustomTarget", "AnsibleEndpoint", "HTTPEndpoint", "SSHEndpoint", "CiscoCatalyst", "PowerShellEndpoint", "CiscoDNAC", "CiscoFMC", "ViptelaCloud", "CatalystSDWANManager", "MerakiCloud", "CiscoISE" ], "default": "", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "Manufacturer of the server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.StorageControllersMetaData.List": { "title": "List of 'capability.StorageControllersMetaData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.StorageControllersMetaData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.StorageControllersMetaData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.StorageControllersMetaData" }, "nullable": true } } } ] }, "capability.SwitchCapability.Response": { "description": "The response body of a HTTP GET request for the 'capability.SwitchCapability' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SwitchCapability' resources.", "x-one-of-name": "capability.SwitchCapability.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SwitchCapability.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SwitchCapability": { "title": "Capability:Switch Capability", "description": "Type to represent additional switch specific capabilities.", "x-allOf-name": "capability.SwitchCapability", "allOf": [ { "$ref": "#/components/schemas/capability.SwitchCapabilityDef" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchCapability', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchCapability" ], "default": "capability.SwitchCapability", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchCapability" ], "default": "capability.SwitchCapability", "x-enum-as-string": true }, "AllowedUplinkPcIdRange": { "description": "Range of port-channel IDs supported on this switch.", "$ref": "#/components/schemas/capability.PcIdRange", "readOnly": true, "x-omitempty": true }, "DefaultFcoeVlan": { "description": "Default Fcoe VLAN associated with this switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DynamicVifsSupported": { "description": "Dynamic VIFs support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "FanModulesSupported": { "description": "Fan Modules support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "FcEndHostModeReservedVsans": { "type": "array", "items": { "description": "Collection of vsan ID ranges that are reserved when switch is in FC end-host mode.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FcUplinkPortsAutoNegotiationSupported": { "description": "Fc Uplink ports auto negotiation speed support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ImmControlsVpcompression": { "description": "VlanPort Compression is controlled by IMM.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "InterClusterLinkVlanSupported": { "description": "Inter cluster link vlan support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LocatorBeaconSupported": { "description": "Locator Beacon LED support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MacsecSupportedPorts": { "type": "array", "items": { "description": "Collection of port ranges that can be used for macsec on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MaxPorts": { "description": "Maximum allowed physical ports on this switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxSlots": { "description": "Maximum allowed physical slots on this switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MinVersionMapForSwitchFeatures": { "type": "array", "items": { "description": "Minimum firmware version supported for features supported in switch.", "$ref": "#/components/schemas/firmware.FeatureVersionMap", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MinVersionMapWithBreakoutSupport": { "description": "Minimum firmware version supported for breakout ports on this switch.", "$ref": "#/components/schemas/firmware.VersionMap", "readOnly": true, "x-omitempty": true }, "MinVersionMapWithLocatorLedSupport": { "description": "Minimum firmware version supported for locator leds on this switch.", "$ref": "#/components/schemas/firmware.VersionMap", "readOnly": true, "x-omitempty": true }, "MinVersionMapWithNegAuto25gSupport": { "description": "Minimum firmware version supported for 'negotiate auto 25000' port admin speed on this switch.", "$ref": "#/components/schemas/firmware.VersionMap", "readOnly": true, "x-omitempty": true }, "NetworkLimits": { "description": "List of network limitations for this switch.", "$ref": "#/components/schemas/capability.SwitchNetworkLimits", "readOnly": true, "x-omitempty": true }, "PortsSupporting100gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 100 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting10gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 10 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting1gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 1 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting25gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 25 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting400gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 400 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting40gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 40 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupporting50gSpeed": { "type": "array", "items": { "description": "Collection of port ranges that support 50 Gbps speed on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupportingApplianceRole": { "type": "array", "items": { "description": "Collection of port ranges that support Appliance role on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupportingBreakout": { "type": "array", "items": { "description": "Collection of port ranges that support Breakout capability on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupportingFcoe": { "type": "array", "items": { "description": "Collection of port ranges that support Fcoe on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupportingInterClusterLink": { "type": "array", "items": { "description": "Collection of port ranges that support the inter cluster configuration on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PortsSupportingServerRole": { "type": "array", "items": { "description": "Collection of port ranges that support Server role configuration on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReservedVsans": { "type": "array", "items": { "description": "Collection of vsan ID ranges that are reserved on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SerenoNetflowSupported": { "description": "Sereno Adaptor with Netflow support on this switch.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ServerRoleSupportedOnBreakout": { "type": "array", "items": { "description": "Support for server role on breakout ports on this switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StorageLimits": { "description": "List of storage limitations for this switch.", "$ref": "#/components/schemas/capability.SwitchStorageLimits", "readOnly": true, "x-omitempty": true }, "SwitchingModeCapabilities": { "type": "array", "items": { "description": "SwitchingMode limitation for this switch.", "$ref": "#/components/schemas/capability.SwitchingModeCapability", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SystemLimits": { "description": "List of system limitations for this switch.", "$ref": "#/components/schemas/capability.SwitchSystemLimits", "readOnly": true, "x-omitempty": true }, "UnSupportedEquipmentModel": { "type": "array", "items": { "description": "Unsupported Equipment Model type for this switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UnifiedPorts": { "type": "array", "items": { "description": "Range of ports that support Unified capability on this switch.", "$ref": "#/components/schemas/capability.PortRange", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UnifiedRule": { "description": "The Slider rule for Unified ports on this switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "UplinkAdminPortSpeedNegAuto25GbpsSupported": { "description": "'Negotiate Auto 25000' admin speed support on this switch for port or port-channel\nwith Ethernet Uplink/Appliance/FCoE Uplink roles.", "type": "boolean", "readOnly": true, "x-omitempty": true } } } ] }, "capability.SwitchCapability.List": { "title": "List of 'capability.SwitchCapability' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SwitchCapability' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SwitchCapability' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SwitchCapability" }, "nullable": true } } } ] }, "capability.SwitchCapabilityDef": { "title": "Capability:Switch Capability Def", "description": "Abstract class that defines properties common for all Switch specific 'defs'.", "x-allOf-name": "capability.SwitchCapabilityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchCapabilityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.SwitchCapability", "capability.SwitchManufacturingDef" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.EquipmentPhysicalDef", "capability.EquipmentSlotArray", "capability.SwitchCapability", "capability.SwitchManufacturingDef" ], "x-enum-as-string": true }, "Pid": { "description": "Product Identifier for a Switch/Fabric-Interconnect.\n* `UCS-FI-6454` - The standard 4th generation UCS Fabric Interconnect with 54 ports.\n* `UCS-FI-64108` - The expanded 4th generation UCS Fabric Interconnect with 108 ports.\n* `UCS-FI-6536` - The standard 5th generation UCS Fabric Interconnect with 36 ports.\n* `UCSX-S9108-100G` - Cisco UCS Fabric Interconnect 9108 100G with 8 ports.\n* `UCS-FI-6664` - The standard 6th generation UCS Fabric Interconnect with 64 ports.\n* `UCS-FI-6652` - The standard 6th generation UCS Fabric Interconnect with 52 ports.\n* `UCSXE-ECMC-10G` - Cisco UCS XE ECMC 10G with 2 ports.\n* `UCSXE-ECMC-G1` - Cisco UCS XE ECMC G1 with 2 ports.\n* `unknown` - Unknown device type, usage is TBD.", "type": "string", "enum": [ "UCS-FI-6454", "UCS-FI-64108", "UCS-FI-6536", "UCSX-S9108-100G", "UCS-FI-6664", "UCS-FI-6652", "UCSXE-ECMC-10G", "UCSXE-ECMC-G1", "unknown" ], "default": "UCS-FI-6454", "x-omitempty": true }, "Sku": { "description": "SKU information for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true }, "Vid": { "description": "VID information for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true } } } ] }, "capability.SwitchControlPolicyConstraints": { "title": "Capability:Switch Control Policy Constraints", "description": "Constraints to be validated for Switch Control policy.", "x-allOf-name": "capability.SwitchControlPolicyConstraints", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchControlPolicyConstraints', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchControlPolicyConstraints" ], "default": "capability.SwitchControlPolicyConstraints", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchControlPolicyConstraints" ], "default": "capability.SwitchControlPolicyConstraints", "x-enum-as-string": true }, "MinBundleVersionForStpModeRpvst": { "description": "Minimum bundle version required to support RPVST mode for Spanning Tree Protocol.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinSwitchVersionForStpModeRpvst": { "description": "Minimum switch firmware version required to support RPVST mode for Spanning Tree Protocol.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.SwitchDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.SwitchDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SwitchDescriptor' resources.", "x-one-of-name": "capability.SwitchDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SwitchDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SwitchDescriptor": { "title": "Capability:Switch Descriptor", "description": "Descriptor that uniquely identifies a Fabric interconnect.", "x-allOf-name": "capability.SwitchDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchDescriptor" ], "default": "capability.SwitchDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchDescriptor" ], "default": "capability.SwitchDescriptor", "x-enum-as-string": true }, "ExpectedMemory": { "description": "The total expected memory for this hardware.", "type": "integer", "format": "int64", "x-omitempty": true }, "IsAvatarEcmc": { "description": "Identifies whether Switch is part of Avatar series.", "type": "boolean", "default": false, "x-omitempty": true }, "IsUcsxDirectSwitch": { "description": "Identifies whether Switch is part of UCSX Direct chassis.", "type": "boolean", "default": false, "x-omitempty": true }, "Revision": { "description": "Revision for the fabric interconnect.", "type": "string", "x-omitempty": true }, "UnsupportedPolicies": { "type": "array", "items": { "description": "Intersight policies that are not applicable for a switch.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "capability.SwitchDescriptor.List": { "title": "List of 'capability.SwitchDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SwitchDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SwitchDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SwitchDescriptor" }, "nullable": true } } } ] }, "capability.SwitchEquipmentInfo.Response": { "description": "The response body of a HTTP GET request for the 'capability.SwitchEquipmentInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SwitchEquipmentInfo' resources.", "x-one-of-name": "capability.SwitchEquipmentInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SwitchEquipmentInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SwitchEquipmentInfo": { "title": "Capability:Switch Equipment Info", "description": "Type to represent additional switch equipment information.", "x-allOf-name": "capability.SwitchEquipmentInfo", "allOf": [ { "$ref": "#/components/schemas/capability.SwitchIdentityDef" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchEquipmentInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchEquipmentInfo" ], "default": "capability.SwitchEquipmentInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchEquipmentInfo" ], "default": "capability.SwitchEquipmentInfo", "x-enum-as-string": true }, "MaxFanModules": { "description": "Maximum number of fan modules/trays present on this switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxFansInFanModule": { "description": "Maximum number of fans present in a fan module/tray on this switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "capability.SwitchEquipmentInfo.List": { "title": "List of 'capability.SwitchEquipmentInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SwitchEquipmentInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SwitchEquipmentInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SwitchEquipmentInfo" }, "nullable": true } } } ] }, "capability.SwitchIdentityDef": { "title": "Capability:Switch Identity Def", "description": "Abstract class that defines properties common for all Switch specific 'defs'.", "x-allOf-name": "capability.SwitchIdentityDef", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchIdentityDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.SwitchEquipmentInfo" ], "default": "capability.SwitchEquipmentInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.SwitchEquipmentInfo" ], "default": "capability.SwitchEquipmentInfo", "x-enum-as-string": true }, "Pid": { "description": "Product Identifier for a Switch/Fabric-Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "SKU information for Switch/Fabric-Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "VID information for Switch/Fabric-Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.SwitchManufacturingDef.Response": { "description": "The response body of a HTTP GET request for the 'capability.SwitchManufacturingDef' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SwitchManufacturingDef' resources.", "x-one-of-name": "capability.SwitchManufacturingDef.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SwitchManufacturingDef.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SwitchManufacturingDef": { "title": "Capability:Switch Manufacturing Def", "description": "Switch/Fabric-Interconnect manufacturing def properties.", "x-allOf-name": "capability.SwitchManufacturingDef", "allOf": [ { "$ref": "#/components/schemas/capability.SwitchCapabilityDef" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchManufacturingDef', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchManufacturingDef" ], "default": "capability.SwitchManufacturingDef", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchManufacturingDef" ], "default": "capability.SwitchManufacturingDef", "x-enum-as-string": true }, "Caption": { "description": "Caption for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true }, "Description": { "description": "Description for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true }, "PartNumber": { "description": "Part Number for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product Name for Switch/Fabric-Interconnect.", "type": "string", "x-omitempty": true } } } ] }, "capability.SwitchManufacturingDef.List": { "title": "List of 'capability.SwitchManufacturingDef' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SwitchManufacturingDef' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SwitchManufacturingDef' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SwitchManufacturingDef" }, "nullable": true } } } ] }, "capability.SwitchNetworkLimits": { "title": "Capability:Switch Network Limits", "description": "Object combines and lists the network-config limits for each of the Fabric/Switch platforms.", "x-allOf-name": "capability.SwitchNetworkLimits", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchNetworkLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchNetworkLimits" ], "default": "capability.SwitchNetworkLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchNetworkLimits" ], "default": "capability.SwitchNetworkLimits", "x-enum-as-string": true }, "MaxCompressedPortVlanCount": { "description": "Maximum Compressed configurable VLANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaxUncompressedPortVlanCount": { "description": "Maximum configurable VLANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumActiveTrafficMonitoringSessions": { "description": "Maximum configured and enabled Traffic Monitoring sessions on this Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumEthernetPortChannels": { "description": "Maximum configurable Ethernet port-channels on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumEthernetUplinkPorts": { "description": "Maximum configurable Ethernet Uplink ports on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumFcPortChannelMembers": { "description": "Maximum configurable Fibre Channel port-channel member ports on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumFcPortChannels": { "description": "Maximum configurable Fibre Channel port-channels on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumIgmpGroups": { "description": "Maximum configurable IGMP Groups on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumPortChannelMembers": { "description": "Maximum configurable ports per each port-channel on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumPrimaryVlan": { "description": "Maximum configurable Primary Private VLANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumSecondaryVlan": { "description": "Maximum configurable Secondary Private VLANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumSecondaryVlanPerPrimary": { "description": "Maximum configurable Secondary VLANs per each Primary VLAN on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumSecureRouterPorts": { "description": "Maximum configurable Secure Router ports on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumVifs": { "description": "Maximum allowes VIFs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumVlans": { "description": "Maximum configurable VLANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MinimumActiveFans": { "description": "Minimum required fans in 'active' state for this Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.SwitchStorageLimits": { "title": "Capability:Switch Storage Limits", "description": "Object combines and lists the storage-config limits for each of the Fabric/Switch platforms.", "x-allOf-name": "capability.SwitchStorageLimits", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchStorageLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchStorageLimits" ], "default": "capability.SwitchStorageLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchStorageLimits" ], "default": "capability.SwitchStorageLimits", "x-enum-as-string": true }, "MaximumUserZoneCount": { "description": "Maximum user zones per Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumVirtualFcInterfaces": { "description": "Maximum configurable Virtual Fibre Channel interfaces on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumVirtualFcInterfacesPerBladeServer": { "description": "Maximum configurable Virtual Fibre Channel interfaces per blade.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumVsans": { "description": "Maximum configurable VSANs on Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumZoneCount": { "description": "Zone limit per Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.SwitchSystemLimits": { "title": "Capability:Switch System Limits", "description": "Object combines and lists the storage-config limits for each of the Fabric/Switch platforms.", "x-allOf-name": "capability.SwitchSystemLimits", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchSystemLimits', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchSystemLimits" ], "default": "capability.SwitchSystemLimits", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchSystemLimits" ], "default": "capability.SwitchSystemLimits", "x-enum-as-string": true }, "MaximumChassisCount": { "description": "Maximum UCS chassis that can be connected to this Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumFexPerDomain": { "description": "Maximum UCS Fabric-extenders (FEX) per Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true }, "MaximumServersPerDomain": { "description": "Maximum UCS servers per Switch/Fabric-Interconnect.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "capability.SwitchUpgradeSupportMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.SwitchUpgradeSupportMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.SwitchUpgradeSupportMeta' resources.", "x-one-of-name": "capability.SwitchUpgradeSupportMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.SwitchUpgradeSupportMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.SwitchUpgradeSupportMeta": { "title": "Capability:Switch Upgrade Support Meta", "description": "Internal meta-data to enable block domain upgrade/downgrade when certain components are connected.", "x-allOf-name": "capability.SwitchUpgradeSupportMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchUpgradeSupportMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchUpgradeSupportMeta" ], "default": "capability.SwitchUpgradeSupportMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchUpgradeSupportMeta" ], "default": "capability.SwitchUpgradeSupportMeta", "x-enum-as-string": true }, "Description": { "description": "Information related to the list of Component models.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaxVersion": { "description": "Maximum Fabric Interconnect version for the component to be supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "MinVersion": { "description": "Minimum Fabric Interconnect version for the component to be supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "SeriesId": { "description": "Series names of Component.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of component models which fall under this series.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.SwitchUpgradeSupportMeta.List": { "title": "List of 'capability.SwitchUpgradeSupportMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.SwitchUpgradeSupportMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.SwitchUpgradeSupportMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.SwitchUpgradeSupportMeta" }, "nullable": true } } } ] }, "capability.SwitchingModeCapability": { "title": "Capability:Switching Mode Capability", "description": "Combines and lists the Switching mode capability for each of the Fabric/Switch Platforms.", "x-allOf-name": "capability.SwitchingModeCapability", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.SwitchingModeCapability', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.SwitchingModeCapability" ], "default": "capability.SwitchingModeCapability", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.SwitchingModeCapability" ], "default": "capability.SwitchingModeCapability", "x-enum-as-string": true }, "SwitchingMode": { "description": "Switching mode type (endhost, switch) of the switch.\n* `end-host` - In end-host mode, the fabric interconnects appear to the upstream devices as end hosts with multiple links.In this mode, the switch does not run Spanning Tree Protocol and avoids loops by following a set of rules for traffic forwarding.In case of ethernet switching mode - Ethernet end-host mode is also known as Ethernet host virtualizer.\n* `switch` - In switch mode, the switch runs Spanning Tree Protocol to avoid loops, and broadcast and multicast packets are handled in the traditional way.This is the traditional switch mode.", "type": "string", "enum": [ "end-host", "switch" ], "default": "end-host", "x-omitempty": true }, "VpCompressionSupported": { "description": "VP Compression support on this switch.", "type": "boolean", "x-omitempty": true } } } ] }, "capability.TemplateCatalog.Response": { "description": "The response body of a HTTP GET request for the 'capability.TemplateCatalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.TemplateCatalog' resources.", "x-one-of-name": "capability.TemplateCatalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.TemplateCatalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.TemplateCatalog": { "title": "Capability:Template Catalog", "description": "The TemplateCatalog object lists the settings that can be overridden in vNIC and vHBA templates, allowing flexible template management and customization.\n#### Purpose\nA TemplateCatalog serves as an authoritative source for allowed overrides in template configurations, facilitating efficient management of vNIC and vHBA resources. It supports read operations to ensure consistent access to override options.\n#### Key Concepts\n- **Override Management:** Catalogs properties that can be overridden, enhancing flexibility and customization in template configurations.\n- **Template Integration:** Focuses on vNIC and vHBA templates, ensuring streamlined management and deployment within server environments.\n- **Access Control:** Managed through privilege sets to ensure secure and reliable access to template catalog information.\n- **Versioning and Updates:** Supports meta version updates, ensuring that override capabilities are current and aligned with system requirements.", "x-allOf-name": "capability.TemplateCatalog", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.TemplateCatalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.TemplateCatalog" ], "default": "capability.TemplateCatalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.TemplateCatalog" ], "default": "capability.TemplateCatalog", "x-enum-as-string": true }, "AllowedOverrideList": { "type": "array", "items": { "description": "List of properties that can be overridden on the template by enabling the AllowOverride property on the template.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.TemplateCatalog.List": { "title": "List of 'capability.TemplateCatalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.TemplateCatalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.TemplateCatalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.TemplateCatalog" }, "nullable": true } } } ] }, "capability.TimeZoneMetaData.Response": { "description": "The response body of a HTTP GET request for the 'capability.TimeZoneMetaData' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.TimeZoneMetaData' resources.", "x-one-of-name": "capability.TimeZoneMetaData.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.TimeZoneMetaData.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.TimeZoneMetaData": { "title": "Capability:Time Zone Meta Data", "description": "Minimal metadata mapping server name to supported time zones.", "x-allOf-name": "capability.TimeZoneMetaData", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.TimeZoneMetaData', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.TimeZoneMetaData" ], "default": "capability.TimeZoneMetaData", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.TimeZoneMetaData" ], "default": "capability.TimeZoneMetaData", "x-enum-as-string": true }, "SupportedTimeZones": { "type": "array", "items": { "description": "List of supported time zones.", "type": "string", "x-omitempty": true }, "nullable": true }, "TargetType": { "description": "Server name (e.g., Mustang, UCS).", "type": "string", "x-omitempty": true } } } ] }, "capability.TimeZoneMetaData.List": { "title": "List of 'capability.TimeZoneMetaData' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.TimeZoneMetaData' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.TimeZoneMetaData' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.TimeZoneMetaData" }, "nullable": true } } } ] }, "capability.UnsupportedFeatureConfig": { "title": "Unsupported Feature Configuration", "description": "UnsUpported Feature Configuration specific to the adapter feature and generation.", "x-allOf-name": "capability.UnsupportedFeatureConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.UnsupportedFeatureConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.UnsupportedFeatureConfig" ], "default": "capability.UnsupportedFeatureConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.UnsupportedFeatureConfig" ], "default": "capability.UnsupportedFeatureConfig", "x-enum-as-string": true }, "Generation": { "description": "The adapter generations that support this feature.\n* `4` - Fourth generation adapters (14xx). The PIDs of these adapters end with the string 04.\n* `2` - Second generation VIC adapters (12xx). The PIDs of these adapters end with the string 02.\n* `3` - Third generation adapters (13xx). The PIDs of these adapters end with the string 03.\n* `5` - Fifth generation adapters (15xx). The PIDs of these adapters contain the V5 string.", "type": "integer", "enum": [ 4, 2, 3, 5 ], "default": 4, "x-omitempty": true }, "UnsupportdFeatures": { "type": "array", "items": { "description": "Unsupported Features specific to the adapter feature and generation.\n* `RoCEv2` - Capability indicator of the RDMA over Converged Ethernet (RoCE) feature version 2.\n* `RoCEv1` - Capability indicator of the RDMA over Converged Ethernet (RoCE) feature version 1.\n* `VMQ` - Capability indicator of the Virtual Machine Queue (VMQ) feature.\n* `VMMQ` - Capability indicator of the Virtual Machine Multi-Queue (VMMQ) feature.\n* `VMQInterrupts` - Capability indicator of the Virtual Machine Queue (VMQ) Interrupts feature.\n* `NVGRE` - Capability indicator of the Network Virtualization using Generic Routing Encapsulation (NVGRE) feature.\n* `ARFS` - Capability indicator of the Accelerated Receive Flow Steering (ARFS) feature.\n* `VXLAN` - Capability indicator of the Virtual Extensible LAN (VXLAN) feature.\n* `usNIC` - Capability indicator of the User Space NIC (usNIC) feature.\n* `Advanced Filter` - Capability indicator of the Advanced Filter feature.\n* `Azure Stack Host QOS` - Capability indicator of the Azure Stack Host QOS feature.\n* `GENEVE Offload` - Capability indicator of the Generic Network Virtualization Encapsulation (Geneve) Offload feature.\n* `QinQ` - Capability indicator of the QinQ feature.\n* `SRIOV` - Capability indicator of the Single Root Input Output Virtualization (SR-IOV).\n* `Ether Channel Pinning` - Capability indicator of the Ether Channel Pinning feature.\n* `IPv6 Iscsi Boot` - Capability indicator of the Iscsi Boot via IPV6 protocol.", "type": "string", "enum": [ "RoCEv2", "RoCEv1", "VMQ", "VMMQ", "VMQInterrupts", "NVGRE", "ARFS", "VXLAN", "usNIC", "Advanced Filter", "Azure Stack Host QOS", "GENEVE Offload", "QinQ", "SRIOV", "Ether Channel Pinning", "IPv6 Iscsi Boot" ], "default": "RoCEv2", "x-omitempty": true }, "nullable": true } } } ] }, "capability.UpdateConstraintMeta": { "title": "Capability:Update Constraint Meta", "description": "Internal meta-data to enable update related constraints.", "x-allOf-name": "capability.UpdateConstraintMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.UpdateConstraintMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.AdapterUpdateConstraintMeta", "capability.ProcessorUnitUpdateConstraintMeta", "capability.StorageControllerUpdateConstraintMeta" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "capability.AdapterUpdateConstraintMeta", "capability.ProcessorUnitUpdateConstraintMeta", "capability.StorageControllerUpdateConstraintMeta" ], "x-enum-as-string": true }, "IsSecureBootSupported": { "description": "Flag to indicate support for secure boot.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MinSupportedVersion": { "description": "Firmware version below which firmware update is not supported for this inventory unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "Model of the inventory unit which will be supported in firmware operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "Platform type for which the constraint is to be enforced.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerSpecificConstraint": { "type": "array", "items": { "description": "Server specific meta for which the constraint is to be enforced.", "$ref": "#/components/schemas/capability.ServerComponentConstraint", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.UpdateOrderListType": { "title": "Capability:Update Order List Type", "description": "The list of update orders.", "x-allOf-name": "capability.UpdateOrderListType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.UpdateOrderListType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.UpdateOrderListType" ], "default": "capability.UpdateOrderListType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.UpdateOrderListType" ], "default": "capability.UpdateOrderListType", "x-enum-as-string": true }, "InterimVersion": { "description": "The interim version to be updated to in the update order.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceVersion": { "description": "The source version of the update order.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "List of models for which this update order is applicable.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetVersion": { "description": "The target version of the update order.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "capability.UpdateOrderMeta.Response": { "description": "The response body of a HTTP GET request for the 'capability.UpdateOrderMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.UpdateOrderMeta' resources.", "x-one-of-name": "capability.UpdateOrderMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.UpdateOrderMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.UpdateOrderMeta": { "title": "Capability:Update Order Meta", "description": "Internal meta-data to map update order.", "x-allOf-name": "capability.UpdateOrderMeta", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.UpdateOrderMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.UpdateOrderMeta" ], "default": "capability.UpdateOrderMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.UpdateOrderMeta" ], "default": "capability.UpdateOrderMeta", "x-enum-as-string": true }, "Category": { "description": "The category of the model series.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Verbose description regarding this group.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformTag": { "description": "The platform tag value of the model series.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpdateOrder": { "type": "array", "items": { "description": "List of update orders applicable to this group.", "$ref": "#/components/schemas/capability.UpdateOrderListType", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "capability.UpdateOrderMeta.List": { "title": "List of 'capability.UpdateOrderMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.UpdateOrderMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.UpdateOrderMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.UpdateOrderMeta" }, "nullable": true } } } ] }, "capability.VicDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'capability.VicDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'capability.VicDescriptor' resources.", "x-one-of-name": "capability.VicDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/capability.VicDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "capability.VicDescriptor": { "title": "Capability:Vic Descriptor", "description": "Descriptor that caches VIC ID to PID relation.", "x-allOf-name": "capability.VicDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.Capability" }, { "type": "object", "description": "Definition of the list of properties defined in 'capability.VicDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "capability.VicDescriptor" ], "default": "capability.VicDescriptor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "capability.VicDescriptor" ], "default": "capability.VicDescriptor", "x-enum-as-string": true }, "Model": { "description": "The model of the endpoint, for which this capability information is applicable.", "type": "string", "x-omitempty": true }, "VicId": { "description": "Vic Id assigned for the adapter.", "type": "string", "x-omitempty": true } } } ] }, "capability.VicDescriptor.List": { "title": "List of 'capability.VicDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'capability.VicDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'capability.VicDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/capability.VicDescriptor" }, "nullable": true } } } ] }, "certificatemanagement.CertificateBase": { "title": "Certificatemanagement:Certificate Base", "description": "Lists properties that are common to all certificate types.", "x-allOf-name": "certificatemanagement.CertificateBase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'certificatemanagement.CertificateBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "certificatemanagement.Imc", "certificatemanagement.RootCaCertificate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "certificatemanagement.Imc", "certificatemanagement.RootCaCertificate" ], "x-enum-as-string": true }, "Certificate": { "description": "Certificate that is used for verifying the authorization.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/x509.Certificate", "x-omitempty": true }, "Enabled": { "description": "Enable/Disable the certificate in Certificate Management policy.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "certificatemanagement.Imc": { "title": "IMC", "description": "IMC certificate has both Certificate and private key that will be used for IMC.", "x-allOf-name": "certificatemanagement.Imc", "allOf": [ { "$ref": "#/components/schemas/certificatemanagement.CertificateBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'certificatemanagement.Imc', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "certificatemanagement.Imc" ], "default": "certificatemanagement.Imc", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "certificatemanagement.Imc" ], "default": "certificatemanagement.Imc", "x-enum-as-string": true }, "CertType": { "description": "Certificate Type for the certificate management.\n* `None` - Set certificate on the selected end point .\n* `KMIPClient` - Set KMIP certificate on the selected end point.", "type": "string", "enum": [ "None", "KMIPClient" ], "default": "None", "x-omitempty": true }, "IsPrivatekeySet": { "description": "Indicates whether the value of the 'privatekey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Privatekey": { "description": "Private Key which is used to validate the certificate.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "certificatemanagement.Policy.Response": { "description": "The response body of a HTTP GET request for the 'certificatemanagement.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'certificatemanagement.Policy' resources.", "x-one-of-name": "certificatemanagement.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/certificatemanagement.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "certificatemanagement.Policy": { "title": "Certificate Management", "description": "The Certificate Management Policy is a reusable policy for managing security certificates on endpoints such as servers and Fabric Interconnects. This provides a centralized way to deploy custom certificates and their corresponding private keys.\n#### Purpose\nThe main purpose of this policy is to replace the default, self-signed certificates on management controllers (like a server's CIMC) with custom certificates signed by a trusted Certificate Authority (CA). This enhances security by ensuring that management interfaces are trusted and that communication is encrypted. It also supports the deployment of Root CA certificates for validating external services.\n#### Key Concepts\n- **Centralized Certificate Deployment:** Allows administrators to manage and deploy X.509 certificates and private keys from a single policy to multiple endpoints.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to Server or Chassis Profiles to ensure consistent certificate configuration across managed devices.\n- **Supports Multiple Certificate Types:** The policy can manage different types of certificates, including IMC certificates (for the management controller itself) and Root CA certificates (for trusting external services like LDAP).\n- **Secure Credential Handling:** The private key associated with a certificate is a write-only, encrypted property, ensuring it is handled securely within the system.", "x-allOf-name": "certificatemanagement.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'certificatemanagement.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "certificatemanagement.Policy" ], "default": "certificatemanagement.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "certificatemanagement.Policy" ], "default": "certificatemanagement.Policy", "x-enum-as-string": true }, "Certificates": { "type": "array", "items": { "description": "Set of certificates to be configured.", "$ref": "#/components/schemas/certificatemanagement.CertificateBase", "x-omitempty": true }, "minItems": 0, "maxItems": 2550, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "certificatemanagement.Policy.List": { "title": "List of 'certificatemanagement.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'certificatemanagement.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'certificatemanagement.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/certificatemanagement.Policy" }, "nullable": true } } } ] }, "certificatemanagement.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'certificatemanagement.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'certificatemanagement.PolicyInventory' resources.", "x-one-of-name": "certificatemanagement.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/certificatemanagement.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "certificatemanagement.PolicyInventory": { "title": "Certificate Management", "description": "The Certificate Management Policy is a reusable policy for managing security certificates on endpoints such as servers and Fabric Interconnects. This provides a centralized way to deploy custom certificates and their corresponding private keys.\n#### Purpose\nThe main purpose of this policy is to replace the default, self-signed certificates on management controllers (like a server's CIMC) with custom certificates signed by a trusted Certificate Authority (CA). This enhances security by ensuring that management interfaces are trusted and that communication is encrypted. It also supports the deployment of Root CA certificates for validating external services.\n#### Key Concepts\n- **Centralized Certificate Deployment:** Allows administrators to manage and deploy X.509 certificates and private keys from a single policy to multiple endpoints.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to Server or Chassis Profiles to ensure consistent certificate configuration across managed devices.\n- **Supports Multiple Certificate Types:** The policy can manage different types of certificates, including IMC certificates (for the management controller itself) and Root CA certificates (for trusting external services like LDAP).\n- **Secure Credential Handling:** The private key associated with a certificate is a write-only, encrypted property, ensuring it is handled securely within the system.", "x-allOf-name": "certificatemanagement.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'certificatemanagement.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "certificatemanagement.PolicyInventory" ], "default": "certificatemanagement.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "certificatemanagement.PolicyInventory" ], "default": "certificatemanagement.PolicyInventory", "x-enum-as-string": true }, "Certificates": { "type": "array", "items": { "description": "Set of certificates to be configured.", "$ref": "#/components/schemas/certificatemanagement.CertificateBase", "readOnly": true, "x-omitempty": true }, "minItems": 0, "maxItems": 2550, "nullable": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "certificatemanagement.PolicyInventory.List": { "title": "List of 'certificatemanagement.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'certificatemanagement.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'certificatemanagement.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/certificatemanagement.PolicyInventory" }, "nullable": true } } } ] }, "certificatemanagement.RootCaCertificate": { "title": "Root CA Certificate", "description": "Root CA Certificate used for HTTPS server authentication and TLS communication with LDAP server.", "x-allOf-name": "certificatemanagement.RootCaCertificate", "allOf": [ { "$ref": "#/components/schemas/certificatemanagement.CertificateBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'certificatemanagement.RootCaCertificate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "certificatemanagement.RootCaCertificate" ], "default": "certificatemanagement.RootCaCertificate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "certificatemanagement.RootCaCertificate" ], "default": "certificatemanagement.RootCaCertificate", "x-enum-as-string": true }, "CertificateName": { "description": "A name that helps identify a certificate. It can be any string that adheres to the following constraints. It should start and end with an alphanumeric character. It can have underscores and hyphens. It cannot be more than 30 characters.", "type": "string", "pattern": "((^[a-zA-Z0-9]$){1,30}|(^(([a-zA-Z0-9])([a-zA-Z0-9_\\-]{0,28})([a-zA-Z0-9]))$))", "x-omitempty": true } } } ] }, "chassis.BaseProfile.Relationship": { "description": "A relationship to the 'chassis.BaseProfile' resource, or the expanded 'chassis.BaseProfile' resource, or the 'null' value.", "x-one-of-name": "chassis.BaseProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.BaseProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.BaseProfile": { "title": "Abstract Class for Chassis Profile and Profile Template", "description": "Abstract class for chassis profile and profile template.", "x-allOf-name": "chassis.BaseProfile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.BaseProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "chassis.Profile", "chassis.ProfileTemplate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "chassis.Profile", "chassis.ProfileTemplate" ], "x-enum-as-string": true }, "TargetPlatform": { "description": "The platform for which the chassis profile is applicable. It can either be a chassis that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `FIAttached` - Chassis which are connected to a Fabric Interconnect that is managed by Intersight.", "type": "string", "enum": [ "FIAttached" ], "default": "FIAttached", "x-omitempty": true }, "ConfigResult": { "$ref": "#/components/schemas/chassis.ConfigResult.Relationship", "description": "A reference to a chassisConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IomProfiles": { "description": "An array of relationships to chassisIomProfile resources.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.IomProfile.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "chassis.ChassisAssignment": { "title": "Chassis:Chassis Assignment", "description": "Chassis assignment information.", "x-allOf-name": "chassis.ChassisAssignment", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ChassisAssignment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ChassisAssignment" ], "default": "chassis.ChassisAssignment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ChassisAssignment" ], "default": "chassis.ChassisAssignment", "x-enum-as-string": true }, "ChassisSerial": { "description": "Serial number of the chassis.", "type": "string", "x-omitempty": true }, "Enabled": { "description": "Indicates if this assignment is enabled.", "type": "boolean", "x-omitempty": true } } } ] }, "chassis.ConfigChangeDetail.Response": { "description": "The response body of a HTTP GET request for the 'chassis.ConfigChangeDetail' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.ConfigChangeDetail' resources.", "x-one-of-name": "chassis.ConfigChangeDetail.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.ConfigChangeDetail.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.ConfigChangeDetail.Relationship": { "description": "A relationship to the 'chassis.ConfigChangeDetail' resource, or the expanded 'chassis.ConfigChangeDetail' resource, or the 'null' value.", "x-one-of-name": "chassis.ConfigChangeDetail.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.ConfigChangeDetail" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.ConfigChangeDetail": { "title": "Chassis:Config Change Detail", "description": "The ConfigChangeDetail object records specific details about configuration changes made to a chassis profile. It enables in-depth tracking of modifications for audit and compliance purposes.\n#### Purpose\nConfigChangeDetail is crucial for maintaining a clear history of changes, allowing administrators to review and understand the impact of each configuration update.\n#### Key Concepts\n- **Change Auditing:** Tracks changes at a granular level, supporting regulatory and operational audit requirements.\n- **Traceability:** Links changes to the relevant profile, ensuring context and accountability.\n- **Compliance Support:** Facilitates compliance monitoring by documenting every configuration alteration.", "x-allOf-name": "chassis.ConfigChangeDetail", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigChangeDetail" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ConfigChangeDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ConfigChangeDetail" ], "default": "chassis.ConfigChangeDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ConfigChangeDetail" ], "default": "chassis.ConfigChangeDetail", "x-enum-as-string": true }, "IomProfile": { "$ref": "#/components/schemas/chassis.IomProfile.Relationship", "description": "A reference to a chassisIomProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "#/components/schemas/chassis.Profile.Relationship", "description": "A reference to a chassisProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "chassis.ConfigChangeDetail.List": { "title": "List of 'chassis.ConfigChangeDetail' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.ConfigChangeDetail' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.ConfigChangeDetail' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigChangeDetail" }, "nullable": true } } } ] }, "chassis.ConfigImport.Response": { "description": "The response body of a HTTP GET request for the 'chassis.ConfigImport' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.ConfigImport' resources.", "x-one-of-name": "chassis.ConfigImport.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.ConfigImport.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.ConfigImport": { "title": "Chassis:Config Import", "description": "Configuration import action will import the existing configuration from chassis and generate Intersight policies profile from it. At end of successful import, chassis will be assigned to the generated profile which has policies associated with it. No chassis profile or policies will be generated if configuration import fails.", "x-allOf-name": "chassis.ConfigImport", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ConfigImport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ConfigImport" ], "default": "chassis.ConfigImport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ConfigImport" ], "default": "chassis.ConfigImport", "x-enum-as-string": true }, "Description": { "description": "Description of the imported profile.", "type": "string", "x-omitempty": true }, "PolicyPrefix": { "description": "Policy prefix for the policies of the imported chassis profile.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,32}$", "x-omitempty": true }, "PolicyTypes": { "type": "array", "items": { "description": "Types of the policies to be imported for the imported chassis profile.", "type": "string", "x-omitempty": true }, "nullable": true }, "ProfileName": { "description": "Profile name for the imported chassis profile.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "Chassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ChassisProfile": { "$ref": "#/components/schemas/chassis.Profile.Relationship", "description": "A reference to a chassisProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "chassis.ConfigImport.List": { "title": "List of 'chassis.ConfigImport' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.ConfigImport' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.ConfigImport' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigImport" }, "nullable": true } } } ] }, "chassis.ConfigResult.Response": { "description": "The response body of a HTTP GET request for the 'chassis.ConfigResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.ConfigResult' resources.", "x-one-of-name": "chassis.ConfigResult.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.ConfigResult.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.ConfigResult.Relationship": { "description": "A relationship to the 'chassis.ConfigResult' resource, or the expanded 'chassis.ConfigResult' resource, or the 'null' value.", "x-one-of-name": "chassis.ConfigResult.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.ConfigResult" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.ConfigResult": { "title": "Chassis:Config Result", "description": "The profile configuration (deploy, validation) results with the overall state and detailed result messages.", "x-allOf-name": "chassis.ConfigResult", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigResult" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ConfigResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ConfigResult" ], "default": "chassis.ConfigResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ConfigResult" ], "default": "chassis.ConfigResult", "x-enum-as-string": true }, "IomProfile": { "$ref": "#/components/schemas/chassis.IomProfile.Relationship", "description": "A reference to a chassisIomProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "#/components/schemas/chassis.BaseProfile.Relationship", "description": "A reference to a chassisBaseProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResultEntries": { "description": "An array of relationships to chassisConfigResultEntry resources.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigResultEntry.Relationship" }, "nullable": true } } } ] }, "chassis.ConfigResult.List": { "title": "List of 'chassis.ConfigResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.ConfigResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.ConfigResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigResult" }, "nullable": true } } } ] }, "chassis.ConfigResultEntry.Response": { "description": "The response body of a HTTP GET request for the 'chassis.ConfigResultEntry' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.ConfigResultEntry' resources.", "x-one-of-name": "chassis.ConfigResultEntry.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.ConfigResultEntry.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.ConfigResultEntry.Relationship": { "description": "A relationship to the 'chassis.ConfigResultEntry' resource, or the expanded 'chassis.ConfigResultEntry' resource, or the 'null' value.", "x-one-of-name": "chassis.ConfigResultEntry.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.ConfigResultEntry" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.ConfigResultEntry": { "title": "Chassis:Config Result Entry", "description": "The ConfigResultEntry object details individual results from configuration and deployment operations. Each entry represents a specific outcome, such as an error, warning, or informational message, related to a profile's configuration.\n#### Purpose\nConfigResultEntry provides granular insight into the steps and checks performed during configuration operations, supporting troubleshooting and compliance.\n#### Key Concepts\n- **Detailed Reporting:** Captures specific messages and context for each stage of the configuration or deployment process.\n- **Linked Results:** Associated with the overall ConfigResult, enabling traceability and contextual understanding of issues.\n- **Systematic Auditing:** Supports comprehensive auditing and diagnosis of configuration events.", "x-allOf-name": "chassis.ConfigResultEntry", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigResultEntry" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ConfigResultEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ConfigResultEntry" ], "default": "chassis.ConfigResultEntry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ConfigResultEntry" ], "default": "chassis.ConfigResultEntry", "x-enum-as-string": true }, "ConfigResult": { "$ref": "#/components/schemas/chassis.ConfigResult.Relationship", "description": "A reference to a chassisConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "chassis.ConfigResultEntry.List": { "title": "List of 'chassis.ConfigResultEntry' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.ConfigResultEntry' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.ConfigResultEntry' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigResultEntry" }, "nullable": true } } } ] }, "chassis.IomProfile.Response": { "description": "The response body of a HTTP GET request for the 'chassis.IomProfile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.IomProfile' resources.", "x-one-of-name": "chassis.IomProfile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.IomProfile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.IomProfile.Relationship": { "description": "A relationship to the 'chassis.IomProfile' resource, or the expanded 'chassis.IomProfile' resource, or the 'null' value.", "x-one-of-name": "chassis.IomProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.IomProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.IomProfile": { "title": "IOM Profile", "description": "The IomProfile object is a specialized component within the chassis configuration framework, designed to manage settings specific to Input/Output Module (IOM) configurations. It facilitates streamlined management of IOMs within chassis, ensuring consistent and effective configuration across networked systems. \n#### Purpose \nIomProfile serves as the configuration container for IOM settings within a chassis, supporting efficient deployment and validation of IOM configurations. \n#### Key Concepts \n- **Targeted Configuration:** Focuses on IOM-specific settings, ensuring precise control over these critical components. \n- **Deployment Insight:** Provides validation and deployment results, aiding in efficient management of IOM configurations. \n- **Integrated Relationships:** Maintains connections with related objects for comprehensive configuration management. \n- **Access Control:** Governed by privilege sets to ensure secure handling of IOM configuration processes.", "x-allOf-name": "chassis.IomProfile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.IomProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.IomProfile" ], "default": "chassis.IomProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.IomProfile" ], "default": "chassis.IomProfile", "x-enum-as-string": true }, "ConfigChanges": { "description": "Pending configuration changes at the summary level. Detail changes are saved in configChangeDetails as a separate object.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.ConfigChange", "readOnly": true, "x-omitempty": true }, "IomEntity": { "description": "IOM in chassis for which IOM profile is applicable. or which is attached to a Fabric Interconnect managed by Intersight.\n* `IOMA` - IOM on left side of chassis.\n* `IOMB` - IOM on right side of chassis.", "type": "string", "enum": [ "IOMA", "IOMB" ], "default": "IOMA", "x-omitempty": true }, "ConfigChangeDetails": { "description": "An array of relationships to chassisConfigChangeDetail resources.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigChangeDetail.Relationship" }, "nullable": true, "readOnly": true }, "ConfigResult": { "$ref": "#/components/schemas/chassis.ConfigResult.Relationship", "description": "A reference to a chassisConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profile": { "$ref": "#/components/schemas/chassis.BaseProfile.Relationship", "description": "A reference to a chassisBaseProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "chassis.IomProfile.List": { "title": "List of 'chassis.IomProfile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.IomProfile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.IomProfile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.IomProfile" }, "nullable": true } } } ] }, "chassis.Profile.Response": { "description": "The response body of a HTTP GET request for the 'chassis.Profile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.Profile' resources.", "x-one-of-name": "chassis.Profile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.Profile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.Profile.Relationship": { "description": "A relationship to the 'chassis.Profile' resource, or the expanded 'chassis.Profile' resource, or the 'null' value.", "x-one-of-name": "chassis.Profile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/chassis.Profile" } ], "discriminator": { "propertyName": "ClassId" } }, "chassis.Profile": { "title": "Chassis Profile", "description": "A profile specifying configuration settings for a chassis.", "x-allOf-name": "chassis.Profile", "allOf": [ { "$ref": "#/components/schemas/chassis.BaseProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.Profile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.Profile" ], "default": "chassis.Profile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.Profile" ], "default": "chassis.Profile", "x-enum-as-string": true }, "ChassisAssignmentMode": { "description": "Source of the chassis assigned to the Chassis Profile. Values can be Static or None. Static is used if a chassis is attached directly to a Chassis Profile. None is used if no chassis is attached to a Chassis Profile. Slot or Serial pre-assignment is also considered to be None as it is different form of Assign Later.\n* `Static` - Chassis is directly assigned to chassis profile using assign chassis.\n* `None` - No chassis is assigned to the chassis profile.", "type": "string", "enum": [ "Static", "None" ], "default": "Static", "x-omitempty": true }, "ChassisPreAssignBySerial": { "description": "Serial number of the chassis that would be assigned to this pre-assigned Chassis Profile. It can be any string that adheres to the following constraints:\nIt should start and end with an alphanumeric character.\nIt cannot be more than 20 characters.", "type": "string", "pattern": "^[a-zA-Z0-9]{0,20}$", "x-omitempty": true }, "ChassisReservation": { "description": "Serial number based reservation for the chassis to be assigned to this Chassis Profile.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resourcepool.ReservationReference", "x-omitempty": true }, "ConfigChangeContext": { "description": "The configuration change state and results of the last change operation.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.ConfigChangeContext", "readOnly": true, "x-omitempty": true }, "ConfigChanges": { "description": "The ConfigChangeDetail object for chassis profiles tracks specific changes made to chassis configurations, supporting comprehensive change management.\n#### Purpose\nChassis ConfigChangeDetail is used for detailed auditing, ensuring that every configuration modification is recorded for compliance and operational integrity.\n#### Key Concepts\n- **Change Documentation:** Maintains a clear record of configuration changes.\n- **Compliance and Audit:** Supports organizational and regulatory requirements for traceability.\n- **Profile Association:** Ensures all changes are linked to the appropriate chassis profile.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.ConfigChange", "readOnly": true, "x-omitempty": true }, "ReservationReferences": { "type": "array", "items": { "description": "The collection of references to reservations that should be used while allocating identities.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference", "x-omitempty": true }, "nullable": true }, "ScheduledChassisAssignment": { "description": "Chassis reassignment information that is captured as part of the config import process.", "$ref": "#/components/schemas/chassis.ChassisAssignment", "x-omitempty": true }, "UserLabel": { "description": "User label assigned to the chassis profile.", "type": "string", "pattern": "^[ !#$%&\\(\\)\\*\\+,\\-\\./:;\\?@\\[\\]_\\{\\|\\}~a-zA-Z0-9]*$", "minLength": 0, "maxLength": 64, "x-omitempty": true }, "AssignedChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "AssociatedChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ConfigChangeDetails": { "description": "An array of relationships to chassisConfigChangeDetail resources.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ConfigChangeDetail.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "RunningWorkflows": { "description": "An array of relationships to workflowWorkflowInfo resources.", "type": "array", "items": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "chassis.Profile.List": { "title": "List of 'chassis.Profile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.Profile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.Profile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.Profile" }, "nullable": true } } } ] }, "chassis.ProfileTemplate.Response": { "description": "The response body of a HTTP GET request for the 'chassis.ProfileTemplate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'chassis.ProfileTemplate' resources.", "x-one-of-name": "chassis.ProfileTemplate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/chassis.ProfileTemplate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "chassis.ProfileTemplate": { "title": "Chassis Profile Template", "description": "The ProfileTemplate object for chassis profiles defines reusable templates for chassis configurations, supporting rapid deployment and consistent configuration across multiple chassis.\n#### Purpose\nChassis ProfileTemplate streamlines the creation, management, and propagation of standardized chassis configurations within an organization.\n#### Key Concepts\n- **Template-Based Deployment:** Accelerates chassis onboarding and ensures consistent application of best practices.\n- **Centralized Management:** Templates can be updated to affect all derived chassis profiles, simplifying large-scale configuration changes.\n- **Lifecycle Integration:** Supports derivation and update workflows, integrating with bulk operations for efficient management.", "x-allOf-name": "chassis.ProfileTemplate", "allOf": [ { "$ref": "#/components/schemas/chassis.BaseProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'chassis.ProfileTemplate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "chassis.ProfileTemplate" ], "default": "chassis.ProfileTemplate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "chassis.ProfileTemplate" ], "default": "chassis.ProfileTemplate", "x-enum-as-string": true }, "Usage": { "description": "The count of the chassis profiles derived from the template.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "chassis.ProfileTemplate.List": { "title": "List of 'chassis.ProfileTemplate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'chassis.ProfileTemplate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'chassis.ProfileTemplate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/chassis.ProfileTemplate" }, "nullable": true } } } ] }, "compute.AdapterUnitConfig": { "title": "Compute:Adapter Unit Config", "description": "Target object representing an Adapter.", "x-allOf-name": "compute.AdapterUnitConfig", "allOf": [ { "$ref": "#/components/schemas/compute.PcieEndpointConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.AdapterUnitConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.AdapterUnitConfig" ], "default": "compute.AdapterUnitConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.AdapterUnitConfig" ], "default": "compute.AdapterUnitConfig", "x-enum-as-string": true }, "AdapterUnitPropFilters": { "type": "array", "items": { "description": "Filters to select Adapters based on hardware specifications.", "$ref": "#/components/schemas/compute.AdapterUnitPropFilter", "x-omitempty": true }, "nullable": true } } } ] }, "compute.AdapterUnitPropFilter": { "title": "Compute:Adapter Unit Prop Filter", "description": "Options to select adapters based on its properties.", "x-allOf-name": "compute.AdapterUnitPropFilter", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.AdapterUnitPropFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.AdapterUnitPropFilter" ], "default": "compute.AdapterUnitPropFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.AdapterUnitPropFilter" ], "default": "compute.AdapterUnitPropFilter", "x-enum-as-string": true }, "Count": { "description": "Number of Adapters to be selected.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 1, "x-omitempty": true }, "Model": { "description": "Specific Adapter model to select.\n* `Any` - To select any Adapter model available in XFM.\n* `UCSC-P-N7S400GF` - Cisco UCS X-Series Adapter with 400G capability and dual port configuration.\n* `UCSC-P-N7D200GF` - Cisco UCS X-Series Adapter with 200G capability and dual port configuration.\n* `UCSC-P-N7S400GFO` - Cisco UCS X-Series SmartNIC with 400G QSFP112 PCIe Gen5 NIC.\n* `UCSC-P-N7D200GFO` - Cisco UCS X-Series SmartNIC with 200G QSFP112 PCIe Gen5 NIC.", "type": "string", "enum": [ "Any", "UCSC-P-N7S400GF", "UCSC-P-N7D200GF", "UCSC-P-N7S400GFO", "UCSC-P-N7D200GFO" ], "default": "Any", "x-omitempty": true } } } ] }, "compute.AlarmSummary": { "title": "Compute:Alarm Summary", "description": "The summary of alarm counts based on alarm serverity.", "x-allOf-name": "compute.AlarmSummary", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.AlarmSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.AlarmSummary" ], "default": "compute.AlarmSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.AlarmSummary" ], "default": "compute.AlarmSummary", "x-enum-as-string": true }, "Critical": { "description": "The count of alarms that have severity type Critical.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Health": { "description": "Health of the managed end point. The highest severity computed from alarmSummary property is set as the health.\n* `Healthy` - The Enum value represents that the entity is healthy.\n* `Warning` - The Enum value Warning represents that the entity has one or more active warnings on it.\n* `Critical` - The Enum value Critical represents that the entity is in a critical state.", "type": "string", "enum": [ "Healthy", "Warning", "Critical" ], "default": "Healthy", "readOnly": true, "x-omitempty": true }, "Info": { "description": "The count of alarms that have severity type Info.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Suppressed": { "description": "The flag that indicates whether suppression is enabled or not in the entity.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SuppressedCritical": { "description": "The count of active suppressed alarms that have severity type Critical.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SuppressedInfo": { "description": "The count of active suppressed alarms that have severity type Info.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SuppressedWarning": { "description": "The count of active suppressed alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Warning": { "description": "The count of alarms that have severity type Warning.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "compute.BaseCluster.Relationship": { "description": "A relationship to the 'compute.BaseCluster' resource, or the expanded 'compute.BaseCluster' resource, or the 'null' value.", "x-one-of-name": "compute.BaseCluster.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.BaseCluster" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.BaseCluster": { "title": "Compute:Base Cluster", "description": "Common attributes of a compute cluster.", "x-allOf-name": "compute.BaseCluster", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/infra.BaseCluster" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.BaseCluster', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "virtualization.VmwareCluster" ], "default": "virtualization.VmwareCluster", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "virtualization.VmwareCluster" ], "default": "virtualization.VmwareCluster", "x-enum-as-string": true }, "StorageClusters": { "description": "An array of relationships to storageBaseCluster resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.BaseCluster.Relationship" }, "nullable": true } } } ] }, "compute.Blade.Response": { "description": "The response body of a HTTP GET request for the 'compute.Blade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.Blade' resources.", "x-one-of-name": "compute.Blade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.Blade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.Blade.Relationship": { "description": "A relationship to the 'compute.Blade' resource, or the expanded 'compute.Blade' resource, or the 'null' value.", "x-one-of-name": "compute.Blade.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Blade" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Blade": { "title": "Compute:Blade", "description": "The compute.Blade object represents a blade server, which is a modular server designed to be housed in a chassis. It encapsulates the server's identity, physical location, lifecycle state, and relationships to its hardware components and management systems.\n#### Purpose\nThe compute.Blade object serves as the primary inventory and management entity for a blade server. This provides a comprehensive, queryable view of the server's state, from its hardware configuration (CPUs, memory, adapters) to its operational status and physical location within a chassis. It is fundamental for all management operations, including discovery, inventory, and lifecycle management.\n#### Key Concepts\n- **Physical Location:** Uniquely identifies the server's location through its chassisId and slotId. It also tracks movement with currentChassisId and currentSlotId.\n- **Lifecycle Management:** The lifecycle property tracks critical events like Moved, Replaced, or SlotMismatch, enabling the system to raise alarms and guide administrative actions.\n- **Hierarchical Inventory:** Acts as a parent container for all of its internal hardware components, such as compute.Board, adapter.Unit, processor.Unit, and memory.Array.\n- **Chassis-Based Resource:** Inherits from equipment.Chassis, establishing its dependency on the chassis for power and connectivity.", "x-allOf-name": "compute.Blade", "allOf": [ { "$ref": "#/components/schemas/compute.Physical" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Blade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.Blade" ], "default": "compute.Blade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.Blade" ], "default": "compute.Blade", "x-enum-as-string": true }, "ChassisId": { "description": "The id of the chassis that the blade is discovered in.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "Location details associated with the managed object. When a top level resource (i.e., Unified Edge Chassis) is assigned to a location, the details of the associated location are propagated to related inventory and configuration objects like servers, profiles, alarms and metrics to facilitate location based filtering.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "ScaledMode": { "description": "The mode of the server that determines it is scaled.", "type": "string", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "The slot number in the chassis that the blade is discovered in.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Adapters": { "description": "An array of relationships to adapterUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.Unit.Relationship" }, "nullable": true, "readOnly": true }, "BiosBootmode": { "$ref": "#/components/schemas/bios.BootMode.Relationship", "description": "A reference to a biosBootMode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BiosTokenSettings": { "$ref": "#/components/schemas/bios.TokenSettings.Relationship", "description": "A reference to a biosTokenSettings resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BiosUnits": { "description": "An array of relationships to biosUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/bios.Unit.Relationship" }, "nullable": true, "readOnly": true }, "BiosVfSelectMemoryRasConfiguration": { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration.Relationship", "description": "A reference to a biosVfSelectMemoryRasConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Bmc": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Board": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "BootDeviceBootmode": { "$ref": "#/components/schemas/boot.DeviceBootMode.Relationship", "description": "A reference to a bootDeviceBootMode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputePersonality": { "description": "An array of relationships to computePersonality resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Personality.Relationship" }, "nullable": true, "readOnly": true }, "ComputeServerPowerParameters": { "$ref": "#/components/schemas/compute.ServerPowerParameters.Relationship", "description": "A reference to a computeServerPowerParameters resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentIoExpanders": { "description": "An array of relationships to equipmentIoExpander resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoExpander.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentRisers": { "description": "An array of relationships to equipmentRiser resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Riser.Relationship" }, "nullable": true, "readOnly": true }, "GenericInventoryHolders": { "description": "An array of relationships to inventoryGenericInventoryHolder resources.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder.Relationship" }, "nullable": true, "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true }, "HybridDriveSlots": { "description": "An array of relationships to equipmentHybridDriveSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.HybridDriveSlot.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryArrays": { "description": "An array of relationships to memoryArray resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Array.Relationship" }, "nullable": true }, "PciDevices": { "description": "An array of relationships to pciDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Device.Relationship" }, "nullable": true, "readOnly": true }, "PciNodes": { "description": "An array of relationships to pciNode resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Node.Relationship" }, "nullable": true, "readOnly": true }, "Processors": { "description": "An array of relationships to processorUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/processor.Unit.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageControllers": { "description": "An array of relationships to storageController resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Controller.Relationship" }, "nullable": true }, "StorageEnclosures": { "description": "An array of relationships to storageEnclosure resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Enclosure.Relationship" }, "nullable": true, "readOnly": true }, "TopSystem": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/top.System.Relationship", "description": "A reference to a topSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "compute.Blade.List": { "title": "List of 'compute.Blade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.Blade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.Blade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Blade" }, "nullable": true } } } ] }, "compute.BladeIdentity.Response": { "description": "The response body of a HTTP GET request for the 'compute.BladeIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.BladeIdentity' resources.", "x-one-of-name": "compute.BladeIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.BladeIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.BladeIdentity.Relationship": { "description": "A relationship to the 'compute.BladeIdentity' resource, or the expanded 'compute.BladeIdentity' resource, or the 'null' value.", "x-one-of-name": "compute.BladeIdentity.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.BladeIdentity" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.BladeIdentity": { "title": "Blade Server Identity Information", "description": "The BladeIdentity object represents a blade server within a chassis and supports lifecycle management operations including decommission, recommission, and rediscover.\n#### Purpose \nA BladeIdentity serves as the canonical record for a blade server's identity and location. It enables consistent discovery and inventory of blades across multiple fabric interconnects, supports lifecycle tracking\u2014from discovery to decommission and recommission-linked to the chassis and device registration, and provides a precise target for policy and configuration deployments scoped to a specific blade instance.\n#### Key Concepts \n- **PhysicalPlacement:** Encodes chassis-and-slot coordinates to locate the blade server in the fabric. \n- **Unique Identification:** Leverages vendor/model/serial and device registration to ensure global uniqueness. \n- **Lifecycle Integration:** Tracks and synchronizes blade discovery, removal, and replacement events. \n- **Relationship Management:** Links to parent device registration and peer blade identities for migrations or replacements.", "x-allOf-name": "compute.BladeIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.PhysicalIdentity" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.BladeIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.BladeIdentity" ], "default": "compute.BladeIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.BladeIdentity" ], "default": "compute.BladeIdentity", "x-enum-as-string": true }, "ChassisId": { "description": "Chassis Identifier of a blade server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentChassisId": { "description": "The id of the chassis that the blade is currently located in.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentSlotId": { "description": "The slot number in the chassis that the blade is currently located in.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FirmwareSupportability": { "description": "Describes whether the running CIMC version supports Intersight managed mode.\n* `Unknown` - The running firmware version is unknown.\n* `Supported` - The running firmware version is known and supports IMM mode.\n* `NotSupported` - The running firmware version is known and does not support IMM mode.", "type": "string", "enum": [ "Unknown", "Supported", "NotSupported" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ManagerSlotId": { "description": "Chassis slot number of the manager compute server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Presence": { "description": "The presence state of the blade server.\n* `Unknown` - The default presence state.\n* `Equipped` - The server is equipped in the slot.\n* `EquippedMismatch` - The slot is equipped, but there is another server currently inventoried in the slot.\n* `Missing` - The server is not present in the given slot.", "type": "string", "enum": [ "Unknown", "Equipped", "EquippedMismatch", "Missing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "Chassis slot number of a blade server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DiscoveredBladeIdInCurrLocation": { "description": "An array of relationships to computeBladeIdentity resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.BladeIdentity.Relationship" }, "nullable": true, "readOnly": true }, "ManagedNodes": { "description": "An array of relationships to computeBladeIdentity resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.BladeIdentity.Relationship" }, "nullable": true, "readOnly": true }, "NewBladeIdInDiscoveredLocation": { "description": "An array of relationships to computeBladeIdentity resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.BladeIdentity.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "compute.BladeIdentity.List": { "title": "List of 'compute.BladeIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.BladeIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.BladeIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.BladeIdentity" }, "nullable": true } } } ] }, "compute.Board.Response": { "description": "The response body of a HTTP GET request for the 'compute.Board' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.Board' resources.", "x-one-of-name": "compute.Board.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.Board.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.Board.Relationship": { "description": "A relationship to the 'compute.Board' resource, or the expanded 'compute.Board' resource, or the 'null' value.", "x-one-of-name": "compute.Board.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Board" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Board": { "title": "Compute:Board", "description": "The compute.Board object represents the main motherboard of a server. It serves as a central container for the core components of the server, such as CPUs, memory, and storage controllers, and reports on its own operational health.\n#### Purpose\nThe primary purpose of the compute.Board object is to model the server's motherboard as a distinct inventory entity. It aggregates the most critical hardware components and provides a focal point for monitoring the board's health, including its power state and any temperature or voltage issues.\n#### Key Concepts\n- **Central Component Hub:** Acts as the parent object for essential hardware like processor.Unit, memory.Array, and storage.Controller, providing a logical grouping for the server's core components.\n- **Health Monitoring:** Reports on its operational status, including power state (operPowerState) and specific health issues (operReason) like temperature or voltage warnings.\n- **Unique Identification:** Identified by a boardId within the server, ensuring it can be uniquely referenced.\n- **Hierarchical Inventory:** Is a child of a compute.RackUnit or compute.Blade, linking it directly to the server it belongs to.", "x-allOf-name": "compute.Board", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Board', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.Board" ], "default": "compute.Board", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.Board" ], "default": "compute.Board", "x-enum-as-string": true }, "BoardId": { "description": "Unique identifier of the mother board present in the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CpuTypeController": { "description": "The type of central processing unit on the mother board.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "Current power state of the mother board of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the mother board.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentTpms": { "description": "An array of relationships to equipmentTpm resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Tpm.Relationship" }, "nullable": true, "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true, "readOnly": true }, "HybridDriveSlots": { "description": "An array of relationships to equipmentHybridDriveSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.HybridDriveSlot.Relationship" }, "nullable": true, "readOnly": true }, "Interconnects": { "description": "An array of relationships to equipmentInterconnect resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Interconnect.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryArrays": { "description": "An array of relationships to memoryArray resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Array.Relationship" }, "nullable": true, "readOnly": true }, "PciCoprocessorCards": { "description": "An array of relationships to pciCoprocessorCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.CoprocessorCard.Relationship" }, "nullable": true, "readOnly": true }, "PciSwitch": { "description": "An array of relationships to pciSwitch resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Switch.Relationship" }, "nullable": true, "readOnly": true }, "PersistentMemoryConfiguration": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration.Relationship", "description": "A reference to a memoryPersistentMemoryConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Processors": { "description": "An array of relationships to processorUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/processor.Unit.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SecurityUnits": { "description": "An array of relationships to securityUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/security.Unit.Relationship" }, "nullable": true, "readOnly": true }, "StorageControllerDrives": { "description": "An array of relationships to storageControllerDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.ControllerDrive.Relationship" }, "nullable": true, "readOnly": true }, "StorageControllers": { "description": "An array of relationships to storageController resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Controller.Relationship" }, "nullable": true, "readOnly": true }, "StorageFlexFlashControllers": { "description": "An array of relationships to storageFlexFlashController resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashController.Relationship" }, "nullable": true, "readOnly": true }, "StorageFlexUtilControllers": { "description": "An array of relationships to storageFlexUtilController resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilController.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "compute.Board.List": { "title": "List of 'compute.Board' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.Board' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.Board' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Board" }, "nullable": true } } } ] }, "compute.CpuConfig": { "title": "Compute:Cpu Config", "description": "Initiator object representing a CPU.", "x-allOf-name": "compute.CpuConfig", "allOf": [ { "$ref": "#/components/schemas/compute.RootPcieEndpointConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.CpuConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.CpuConfig" ], "default": "compute.CpuConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.CpuConfig" ], "default": "compute.CpuConfig", "x-enum-as-string": true }, "CpuId": { "description": "Unique identifier for a CPU in the server.\n* `Any` - To map PCIe devices to any CPU.\n* `1` - Identifier used to map PCIe device to CPU-1.\n* `2` - Identifier used to map PCIe device to CPU-2.", "type": "string", "enum": [ "Any", "1", "2" ], "default": "Any", "x-omitempty": true } } } ] }, "compute.DownloadStatus.Response": { "description": "The response body of a HTTP GET request for the 'compute.DownloadStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.DownloadStatus' resources.", "x-one-of-name": "compute.DownloadStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.DownloadStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.DownloadStatus.Relationship": { "description": "A relationship to the 'compute.DownloadStatus' resource, or the expanded 'compute.DownloadStatus' resource, or the 'null' value.", "x-one-of-name": "compute.DownloadStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.DownloadStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.DownloadStatus": { "title": "Compute:Download Status", "description": "The DownloadStatus object captures the status of file downloads initiated in Cisco endpoints. This provides insights into the progress and completion of download operations.\n#### Purpose\nDownloadStatus serves to track and report the progress of image downloads, ensuring that updates are applied efficiently and correctly. It is an integral part of the workflow for managing server updates and configurations.\n#### Key Concepts\n- **Progress Tracking:** Records stages and percentages of download completion, offering visibility into ongoing operations.\n- **Messaging:** Provides endpoint messages and error details, aiding in troubleshooting download-related issues.\n- **Integration with Workflows:** Links with associated workflows to update status, ensuring synchronized operations.\n- **Access Control:** Defines privilege sets for reading download status, supporting secure management.", "x-allOf-name": "compute.DownloadStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.DownloadStatus" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.DownloadStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.DownloadStatus" ], "default": "compute.DownloadStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.DownloadStatus" ], "default": "compute.DownloadStatus", "x-enum-as-string": true }, "DownloadMessage": { "description": "The message from the endpoint during the download.", "type": "string", "readOnly": true, "x-omitempty": true }, "DownloadPercentage": { "description": "The percentage of the image downloaded in the endpoint.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DownloadStage": { "description": "The image download stages. Example:downloading, flashing.", "type": "string", "readOnly": true, "x-omitempty": true }, "SdCardDownloadError": { "description": "The error message from the endpoint during the SD card download.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostOp": { "$ref": "#/components/schemas/compute.HostUtilityOperation.Relationship", "description": "A reference to a computeHostUtilityOperation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MigrationKeyDetails": { "$ref": "#/components/schemas/server.MigrationKeyDetails.Relationship", "description": "A reference to a serverMigrationKeyDetails resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Workflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.DownloadStatus.List": { "title": "List of 'compute.DownloadStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.DownloadStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.DownloadStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.DownloadStatus" }, "nullable": true } } } ] }, "compute.GpuConfig": { "title": "Compute:Gpu Config", "description": "Target object representing a GPU.", "x-allOf-name": "compute.GpuConfig", "allOf": [ { "$ref": "#/components/schemas/compute.PcieEndpointConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.GpuConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.GpuConfig" ], "default": "compute.GpuConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.GpuConfig" ], "default": "compute.GpuConfig", "x-enum-as-string": true }, "GpuPropFilters": { "type": "array", "items": { "description": "Filters to select GPUs based on hardware specifications.", "$ref": "#/components/schemas/compute.GpuPropFilter", "x-omitempty": true }, "nullable": true } } } ] }, "compute.GpuPropFilter": { "title": "Compute:Gpu Prop Filter", "description": "Options to select a GPU based on its properties.", "x-allOf-name": "compute.GpuPropFilter", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.GpuPropFilter', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.GpuPropFilter" ], "default": "compute.GpuPropFilter", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.GpuPropFilter" ], "default": "compute.GpuPropFilter", "x-enum-as-string": true }, "Count": { "description": "Number of GPUs to be selected.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 2, "x-omitempty": true }, "Model": { "description": "Specific GPU model to select.\n* `Any` - To select any GPU model available in GPU Node.\n* `UCSC-GPU-H100-NVL` - NVIDIA H100 GPU with NVL interface.\n* `UCSC-GPU-H200-NVL` - NVIDIA H200 GPU with NVLink interface.\n* `UCSC-GPU-L40S` - NVIDIA L40S GPU with PCIe interface.\n* `UCSC-GPU-RTXP6000` - NVIDIA RTXP6000 GPU with PCIe interface.\n* `UCSC-GPU-RTXP4500` - NVIDIA RTXP4500 GPU with PCIe interface.", "type": "string", "enum": [ "Any", "UCSC-GPU-H100-NVL", "UCSC-GPU-H200-NVL", "UCSC-GPU-L40S", "UCSC-GPU-RTXP6000", "UCSC-GPU-RTXP4500" ], "default": "Any", "x-omitempty": true } } } ] }, "compute.HostUtilityOperation.Response": { "description": "The response body of a HTTP GET request for the 'compute.HostUtilityOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.HostUtilityOperation' resources.", "x-one-of-name": "compute.HostUtilityOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.HostUtilityOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.HostUtilityOperation.Relationship": { "description": "A relationship to the 'compute.HostUtilityOperation' resource, or the expanded 'compute.HostUtilityOperation' resource, or the 'null' value.", "x-one-of-name": "compute.HostUtilityOperation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.HostUtilityOperation" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.HostUtilityOperation": { "title": "Host Utility Operation", "description": "The HostUtilityOperation object manages host operations such as secure erase and scrub within Cisco servers. It facilitates data cleanup tasks while adhering to established policies.\n#### Purpose\nHostUtilityOperation is designed to execute host utility operations efficiently, ensuring that server components are securely erased or scrubbed according to defined configurations. It supports data management policies within Cisco environments.\n#### Key Concepts\n- **Operational Modes:** Supports various modes of operation such as secure erase and scrub, providing flexibility in data cleanup.\n- **Configuration Management:** Includes configurations related to host operations, allowing for tailored data management tasks.\n- **Workflow Integration:** Works with workflows to ensure operations are conducted smoothly and status updates are accurately reflected.\n- **Security:** Ensures operations are performed safely by inheriting permissions from related servers.", "x-allOf-name": "compute.HostUtilityOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.HostUtilityOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.HostUtilityOperation" ], "default": "compute.HostUtilityOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.HostUtilityOperation" ], "default": "compute.HostUtilityOperation", "x-enum-as-string": true }, "HostOpConfig": { "description": "Host operation related configuration such as scrub components those need to be cleared while scrub are specified using this configuration.", "$ref": "#/components/schemas/compute.HostUtilityOperationConfguration", "x-omitempty": true }, "HostUtilityOperationMode": { "description": "Host utility operation need to be performed in the endpoint.\n* `None` - Host utility mode of the operation is set to none by default.\n* `SecureErase` - EU LOT-9 secure data cleanup on the server components.\n* `SecureEraseWithDecommission` - EU LOT-9 secure data cleanup on the server components and do decommission.\n* `SecureEraseWithDecommissionAndRemove` - EU LOT-9 secure data cleanup on the server components and do decommission and remove.\n* `Scrub` - Quick cleanup on storage and BIOS.", "type": "string", "enum": [ "None", "SecureErase", "SecureEraseWithDecommission", "SecureEraseWithDecommissionAndRemove", "Scrub" ], "default": "None", "x-omitempty": true }, "HostUtilityOperationStatus": { "description": "Task status of the host utility operation.\n* `Initiated` - This status indicates that host utility operation request is initiated.\n* `InProgress` - The operation status indicates that host utility operation is in-progress after the basic validations.\n* `CompletedOk` - The operation status indicates that host utility operation is completed successfully with no error or warning.\n* `CompletedError` - The operation status indicates that host utility operation is completed with error.\n* `CompletedWarning` - The operation status indicates that host utility operation is completed with warning.\n* `Aborted` - The operation status indicates that host utility operation is terminated or aborted.\n* `Invalidated` - The operation status indicates that host utility operation is invalid due to validation failure.", "type": "string", "enum": [ "Initiated", "InProgress", "CompletedOk", "CompletedError", "CompletedWarning", "Aborted", "Invalidated" ], "default": "Initiated", "readOnly": true, "x-omitempty": true }, "DownloadStatus": { "$ref": "#/components/schemas/compute.DownloadStatus.Relationship", "description": "A reference to a computeDownloadStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Workflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.HostUtilityOperation.List": { "title": "List of 'compute.HostUtilityOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.HostUtilityOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.HostUtilityOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.HostUtilityOperation" }, "nullable": true } } } ] }, "compute.HostUtilityOperationConfguration": { "title": "Compute:Host Utility Operation Confguration", "description": "Host Utility operation related confgiruations to use.", "x-allOf-name": "compute.HostUtilityOperationConfguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "compute.IpAddress": { "title": "Compute:Ip Address", "description": "Complex type representing an IP address in UCSM.", "x-allOf-name": "compute.IpAddress", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.IpAddress', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.IpAddress" ], "default": "compute.IpAddress", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.IpAddress" ], "default": "compute.IpAddress", "x-enum-as-string": true }, "Address": { "description": "IP Address to be used for KVM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Category": { "description": "Category of the Kvm IP Address.\n* `Equipment` - Ip Address assigned to an equipment.\n* `ServiceProfile` - Ip Address assigned to a Service Profile.", "type": "string", "enum": [ "Equipment", "ServiceProfile" ], "default": "Equipment", "readOnly": true, "x-omitempty": true }, "DefaultGateway": { "description": "Default gateway property of KVM IP Address.", "type": "string", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The distinguished name for this managed object.", "type": "string", "readOnly": true, "x-omitempty": true }, "HttpPort": { "description": "HTTP port of an IP Address.", "type": "integer", "format": "int64", "default": 80, "readOnly": true, "x-omitempty": true }, "HttpsPort": { "description": "Secured HTTP port of an IP Address.", "type": "integer", "format": "int64", "default": 443, "readOnly": true, "x-omitempty": true }, "KvmPort": { "description": "Port number on which the KVM is running and used for connecting to KVM console.", "type": "integer", "format": "int64", "default": 2068, "readOnly": true, "x-omitempty": true }, "KvmVlan": { "description": "VLAN Identifier of Inband IP Address.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name to identify the KVM IP Address.\n* `Outband` - The user assigned Out of band IP Address.\n* `Inband` - The user assigned Inband IP Address.", "type": "string", "enum": [ "Outband", "Inband" ], "default": "Outband", "readOnly": true, "x-omitempty": true }, "Subnet": { "description": "Subnet detail of a KVM IP Address.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the KVM IP Address.\n* `MgmtInterface` - Ip Address of a Management Interface.\n* `VnicIpV4StaticAddr` - Static Ipv4 Address of a Virtual Network Interface.\n* `VnicIpV4PooledAddr` - Ipv4 Address of a Virtual Network Interface from an address pool.\n* `VnicIpV4MgmtPooledAddr` - Ipv4 Address of a Virtual Network Interface from a Managed address pool.\n* `VnicIpV6StaticAddr` - Static Ipv6 Address of a Virtual Network Interface.\n* `VnicIpV6MgmtPooledAddr` - Ipv6 Address of a Virtual Network Interface from a Managed address pool.\n* `VnicIpV4ProfDerivedAddr` - Server Profile derived Ipv4 Address of a Virtual Network Interface.\n* `MgmtIpV6ProfDerivedAddr` - Server Profile derived Ipv6 Address used for accessing server management services.", "type": "string", "enum": [ "MgmtInterface", "VnicIpV4StaticAddr", "VnicIpV4PooledAddr", "VnicIpV4MgmtPooledAddr", "VnicIpV6StaticAddr", "VnicIpV6MgmtPooledAddr", "VnicIpV4ProfDerivedAddr", "MgmtIpV6ProfDerivedAddr" ], "default": "MgmtInterface", "readOnly": true, "x-omitempty": true } } } ] }, "compute.Mapping.Response": { "description": "The response body of a HTTP GET request for the 'compute.Mapping' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.Mapping' resources.", "x-one-of-name": "compute.Mapping.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.Mapping.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.Mapping.Relationship": { "description": "A relationship to the 'compute.Mapping' resource, or the expanded 'compute.Mapping' resource, or the 'null' value.", "x-one-of-name": "compute.Mapping.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Mapping" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Mapping": { "title": "Uploaded vMedia Image", "description": "The compute.Mapping object represents a single virtual media image that has been uploaded or mapped to a server. This provides the inventory details for a specific virtual media connection.\n#### Purpose\nThe Mapping object is used to track the state of a virtual media mapping. It inventories key details such as the imageName, the type of media (mediaTypes), and a server-assigned identifier. This allows administrators to see which images are currently available to the server for tasks like OS installation or diagnostics.\n#### Key Concepts\n- **Virtual Media Inventory:** Provides a record of a specific virtual media image connected to the server.\n- **Image Identification:** Stores the imageName and fileLocation (if applicable) to identify the source of the virtual media.\n- **State Tracking:** Although primarily for inventory, it represents a specific mapping session that can be created or removed.\n- **Hierarchical Relationship:** Is a child of the compute.Vmedia object, which represents the overall virtual media configuration for the server.", "x-allOf-name": "compute.Mapping", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Mapping', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.Mapping" ], "default": "compute.Mapping", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.Mapping" ], "default": "compute.Mapping", "x-enum-as-string": true }, "FileLocation": { "description": "Remote image location from where the image is uploaded to server.", "type": "string", "x-omitempty": true }, "Identifier": { "description": "The identity assigned to this Virtual Media Image by server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImageName": { "description": "Image name of uploaded Virtual Media Image.", "type": "string", "readOnly": true, "x-omitempty": true }, "MediaTypes": { "type": "array", "items": { "description": "Media type of uploaded Virtual Media Image.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of Virtual Media mapping assigne by server.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vmedia": { "$ref": "#/components/schemas/compute.Vmedia.Relationship", "description": "A reference to a computeVmedia resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.Mapping.List": { "title": "List of 'compute.Mapping' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.Mapping' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.Mapping' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Mapping" }, "nullable": true } } } ] }, "compute.MigrationKeyInfo": { "title": "Compute:Migration Key Info", "description": "Details about the migration key that gets utilized during the server profile migration process.", "x-allOf-name": "compute.MigrationKeyInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.MigrationKeyInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.MigrationKeyInfo" ], "default": "compute.MigrationKeyInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.MigrationKeyInfo" ], "default": "compute.MigrationKeyInfo", "x-enum-as-string": true }, "BootLunType": { "description": "Type of Boot LUN used to boot the operating system.\n* `SAN` - Refers to the SAN boot type.\n* `Local` - Refers to the Local boot type.", "type": "string", "enum": [ "SAN", "Local" ], "default": "SAN", "readOnly": true, "x-omitempty": true }, "InitiatorAddresses": { "type": "array", "items": { "description": "A collection of initiator addresses linked to the migration key.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InstanceId": { "description": "Unique Identifier that represents the boot lun instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsKeyValueSet": { "description": "Indicates whether the value of the 'keyValue' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "LunId": { "description": "Identifies the LUN ID associated with the migration key.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TargetAddresses": { "type": "array", "items": { "description": "A collection of target addresses linked to the migration key.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TpmSerial": { "description": "Serial Id of the associated TPM module in the server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "compute.PcieConnectivityPolicy.Response": { "description": "The response body of a HTTP GET request for the 'compute.PcieConnectivityPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.PcieConnectivityPolicy' resources.", "x-one-of-name": "compute.PcieConnectivityPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.PcieConnectivityPolicy": { "title": "PCIe Connectivity", "description": "Configures PCIe connectivity policy to map GPUs and Adapters to a server.", "x-allOf-name": "compute.PcieConnectivityPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PcieConnectivityPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PcieConnectivityPolicy" ], "default": "compute.PcieConnectivityPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PcieConnectivityPolicy" ], "default": "compute.PcieConnectivityPolicy", "x-enum-as-string": true }, "PcieZones": { "type": "array", "items": { "description": "Configuration that defines devices to be mapped to CPU.", "$ref": "#/components/schemas/compute.PcieZone", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "compute.PcieConnectivityPolicy.List": { "title": "List of 'compute.PcieConnectivityPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.PcieConnectivityPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.PcieConnectivityPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicy" }, "nullable": true } } } ] }, "compute.PcieConnectivityPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'compute.PcieConnectivityPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.PcieConnectivityPolicyInventory' resources.", "x-one-of-name": "compute.PcieConnectivityPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.PcieConnectivityPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.PcieConnectivityPolicyInventory": { "title": "PCIe Connectivity", "description": "Configures PCIe connectivity policy to map GPUs and Adapters to a server.", "x-allOf-name": "compute.PcieConnectivityPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PcieConnectivityPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PcieConnectivityPolicyInventory" ], "default": "compute.PcieConnectivityPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PcieConnectivityPolicyInventory" ], "default": "compute.PcieConnectivityPolicyInventory", "x-enum-as-string": true }, "PcieZones": { "type": "array", "items": { "description": "Configuration that defines devices to be mapped to CPU.", "$ref": "#/components/schemas/compute.PcieZone", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.PcieConnectivityPolicyInventory.List": { "title": "List of 'compute.PcieConnectivityPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.PcieConnectivityPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.PcieConnectivityPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.PcieConnectivityPolicyInventory" }, "nullable": true } } } ] }, "compute.PcieEndpointConfig": { "title": "Compute:Pcie Endpoint Config", "description": "Common properties for all PCIe endpoint objects. Serves as the base class for all PCI target types.", "x-allOf-name": "compute.PcieEndpointConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PcieEndpointConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.AdapterUnitConfig", "compute.GpuConfig" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.AdapterUnitConfig", "compute.GpuConfig" ], "x-enum-as-string": true }, "PcieEndpointType": { "description": "Type of PCIe endpoint device.\n* `GPU` - The PCIe endpoint type is GPU.\n* `Adapter` - The PCIe endpoint type is Adapter.", "type": "string", "enum": [ "GPU", "Adapter" ], "default": "GPU", "x-omitempty": true } } } ] }, "compute.PcieZone": { "title": "Compute:Pcie Zone", "description": "Configuration for a PCIe zone.", "x-allOf-name": "compute.PcieZone", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PcieZone', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PcieZone" ], "default": "compute.PcieZone", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PcieZone" ], "default": "compute.PcieZone", "x-enum-as-string": true }, "PcieEndpoints": { "type": "array", "items": { "description": "Collection of PCIe endpoint devices to be mapped to CPU.", "$ref": "#/components/schemas/compute.PcieEndpointConfig", "x-omitempty": true }, "nullable": true }, "RootPcieEndpoint": { "description": "Root PCIe endpoint device in a zone.", "$ref": "#/components/schemas/compute.RootPcieEndpointConfig", "x-omitempty": true } } } ] }, "compute.PendingWorkflowTrigger": { "title": "Compute:Pending Workflow Trigger", "description": "A workflow trigger that is waiting for a response from the workflow engine.", "x-allOf-name": "compute.PendingWorkflowTrigger", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "compute.PersistentMemoryModule": { "title": "Compute:Persistent Memory Module", "description": "Persistent Memory Module on which an operation has to be performed.", "x-allOf-name": "compute.PersistentMemoryModule", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PersistentMemoryModule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PersistentMemoryModule" ], "default": "compute.PersistentMemoryModule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PersistentMemoryModule" ], "default": "compute.PersistentMemoryModule", "x-enum-as-string": true }, "SocketId": { "description": "Socket ID of the Persistent Memory Module on the server.", "type": "string", "x-omitempty": true }, "SocketMemoryId": { "description": "Socket Memory ID of the Persistent Memory Module on the server.", "type": "string", "x-omitempty": true } } } ] }, "compute.PersistentMemoryOperation": { "title": "Compute:Persistent Memory Operation", "description": "The operation that can be performed on the Persistent Memory Modules on the servers.", "x-allOf-name": "compute.PersistentMemoryOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PersistentMemoryOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PersistentMemoryOperation" ], "default": "compute.PersistentMemoryOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PersistentMemoryOperation" ], "default": "compute.PersistentMemoryOperation", "x-enum-as-string": true }, "AdminAction": { "description": "Administrative actions that can be performed on the Persistent Memory Modules.\n* `None` - No action on the selected Persistent Memory Modules.\n* `SecureErase` - Secure Erase action on the selected Persistent Memory Modules.\n* `Unlock` - Unlock action on the selected Persistent Memory Modules.", "type": "string", "enum": [ "None", "SecureErase", "Unlock" ], "default": "None", "x-omitempty": true }, "IsSecurePassphraseSet": { "description": "Indicates whether the value of the 'securePassphrase' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Modules": { "type": "array", "items": { "description": "Selected Persistent Memory Modules on the server.", "$ref": "#/components/schemas/compute.PersistentMemoryModule", "x-omitempty": true }, "nullable": true }, "SecurePassphrase": { "description": "Secure passphrase of the Persistent Memory Modules of the server.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "compute.Personality.Response": { "description": "The response body of a HTTP GET request for the 'compute.Personality' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.Personality' resources.", "x-one-of-name": "compute.Personality.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.Personality.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.Personality.Relationship": { "description": "A relationship to the 'compute.Personality' resource, or the expanded 'compute.Personality' resource, or the 'null' value.", "x-one-of-name": "compute.Personality.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Personality" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Personality": { "title": "Compute:Personality", "description": "The compute.Personality object provides a mechanism to model a server with a defined software personality, separate from its physical hardware identity (PID). This allows for logical grouping or classification of servers based on their role or software stack.\n#### Purpose\nThe main purpose of the compute.Personality object is to assign a logical identity to a server. This can be used for organizing servers, applying specific software-defined policies, or identifying servers that belong to a particular solution (e.g., a node in a hyper-converged cluster). This provides a flexible way to manage servers based on their function rather than just their hardware.\n#### Key Concepts\n- **Logical Identity:** Assigns a name and personalityId to a server that is independent of its physical model or serial number.\n- **Flexible Grouping:** Allows servers to be grouped and managed based on their assigned personality.\n- **Extensibility:** The additionalInfo field provides a space for custom metadata related to the personality.\n- **Server Association:** Directly linked to a compute.RackUnit or compute.Blade, applying the logical identity to a specific physical server.", "x-allOf-name": "compute.Personality", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Personality', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.Personality" ], "default": "compute.Personality", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.Personality" ], "default": "compute.Personality", "x-enum-as-string": true }, "AdditionalInfo": { "description": "Additional info about the added software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "PersonalityId": { "description": "Unique identity of added software personality.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.Personality.List": { "title": "List of 'compute.Personality' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.Personality' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.Personality' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Personality" }, "nullable": true } } } ] }, "compute.PersonalitySetting": { "title": "Compute:Personality Setting", "description": "The personality value with additional related information that is to be set for a server.", "x-allOf-name": "compute.PersonalitySetting", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PersonalitySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PersonalitySetting" ], "default": "compute.PersonalitySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PersonalitySetting" ], "default": "compute.PersonalitySetting", "x-enum-as-string": true }, "AdditionalInformation": { "description": "Additional information to be set along with the personality value. This can include information like the\nhypervisor type, last update time etc..", "nullable": true, "writeOnly": true, "x-omitempty": true }, "Personality": { "description": "The personality value that is to be set for the server.", "type": "string", "writeOnly": true, "x-omitempty": true } } } ] }, "compute.Physical.Relationship": { "description": "A relationship to the 'compute.Physical' resource, or the expanded 'compute.Physical' resource, or the 'null' value.", "x-one-of-name": "compute.Physical.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Physical" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Physical": { "title": "Compute:Physical", "description": "Abstract class for all physical servers.", "x-allOf-name": "compute.Physical", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Physical', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.Blade", "compute.RackUnit" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.Blade", "compute.RackUnit" ], "x-enum-as-string": true }, "AdminPowerState": { "description": "The desired power state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AlarmSummary": { "description": "The summary of alarm counts based on the severity types (Critical or Warning).", "$ref": "#/components/schemas/compute.AlarmSummary", "x-omitempty": true }, "AssetTag": { "description": "The user defined asset tag assigned to the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AvailableMemory": { "description": "The amount of memory available on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "BiosPostComplete": { "description": "The BIOS POST completion status of the server.", "type": "boolean", "x-omitempty": true }, "BmcInventoryReady": { "description": "The BMC inventory readiness status of the server.", "type": "boolean", "x-omitempty": true }, "BootLastState": { "description": "The boot progress state of a rack or blade server.\n* `None` - The server is powered off.\n* `OSBootStarted` - The operating system boot process has started.\n* `OSRunning` - The operating system boot process has started and running.\n* `OEM` - The server is in an OEM-defined startup state.", "type": "string", "enum": [ "None", "OSBootStarted", "OSRunning", "OEM" ], "default": "None", "readOnly": true, "x-omitempty": true }, "BootOemLastState": { "description": "The last known OEM-defined startup state of a rack or blade server.\n* `None` - The server has not yet completed OEM initialization.\n* `PlatformInitializing` - The server is initializing after being powered on.", "type": "string", "enum": [ "None", "PlatformInitializing" ], "default": "None", "readOnly": true, "x-omitempty": true }, "CoolingMode": { "description": "Cooling mode representation of the server.\n* `Air` - Cooling mode of the device is set to Air.\n* `Immersion` - Cooling mode of the device is set to Immersion.", "type": "string", "enum": [ "Air", "Immersion" ], "default": "Air", "readOnly": true, "x-omitempty": true }, "CpuCapacity": { "description": "Total processing capacity of the server.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DimmBlocklisting": { "description": "The DIMM Blocklisting setting configured on the server.\n* `Unknown` - The configured state is unknown.\n* `Enabled` - The configured state is enabled.\n* `Disabled` - The configured state is disabled.", "type": "string", "enum": [ "Unknown", "Enabled", "Disabled" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "FaultSummary": { "description": "The fault summary for the server.", "deprecated": true, "x-sunset": "2027-03-01", "type": "integer", "format": "int64", "x-omitempty": true }, "FrontPanelLockState": { "description": "The actual front panel state of the server.\n* `Unlock` - Front Panel of the server is set to Unlocked state.\n* `Lock` - Front Panel of the server is set to Locked state.", "type": "string", "enum": [ "Unlock", "Lock" ], "default": "Unlock", "x-omitempty": true }, "HardwareUuid": { "description": "The universally unique hardware identity of the server provided by the manufacturer.", "type": "string", "x-omitempty": true }, "HasE3SSupport": { "description": "The flag to indicate server has the support for E3.S drives.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KvmIpAddresses": { "type": "array", "items": { "description": "The list of KVM Ip addresses for the server.", "$ref": "#/components/schemas/compute.IpAddress", "x-omitempty": true }, "nullable": true }, "KvmServerStateEnabled": { "description": "The KVM server state of the server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KvmVendor": { "description": "The KVM Vendor for the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastPowerStateChangedTime": { "description": "The Last host power state changed time of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Lifecycle": { "description": "The lifecycle state of the server. This will map to the discovery lifecycle as represented in the server Identity object.\n* `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment.\n* `Active` - Default Lifecycle State for a physical entity.\n* `Decommissioned` - Decommission Lifecycle state.\n* `SlotReserved` - Blade is inserted in a slot that is reserved for Secure Router.\n* `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state.\n* `DiscoveryFailed` - DiscoveryFailed Lifecycle state.\n* `FirmwareUpgradeInProgress` - Firmware upgrade is in progress on given physical entity.\n* `DiagnosticsInProgress` - Diagnostics is in progress on given physical entity.\n* `SecureEraseInProgress` - Secure Erase is in progress on given physical entity.\n* `ScrubInProgress` - Scrub is in progress on given physical entity.\n* `BladeMigrationInProgress` - Server slot migration is in progress on given physical entity.\n* `SlotMismatch` - The blade server is detected in a different chassis/slot than it was previously.\n* `Removed` - The blade server has been removed from its discovered slot, and not detected anywhere else. Blade inventory can be cleaned up by performing a software remove operation on the physically removed blade.\n* `Moved` - The blade server has been moved from its discovered location to a new location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `Replaced` - The blade server has been removed from its discovered location and another blade has been inserted in that location. Blade inventory can be cleaned up and updated by doing a software remove operation on the physically removed blade.\n* `MovedAndReplaced` - The blade server has been moved from its discovered location to a new location and another blade has been inserted into the old discovered location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `DecommissionAndRemoveInProgress` - Decommission and remove operation is in progress.\n* `DecommissionedForRemove` - Server is decommissioned and once it is physically pulled from chassis, it will be automatically removed from inventory.", "type": "string", "enum": [ "None", "Active", "Decommissioned", "SlotReserved", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "DiagnosticsInProgress", "SecureEraseInProgress", "ScrubInProgress", "BladeMigrationInProgress", "SlotMismatch", "Removed", "Moved", "Replaced", "MovedAndReplaced", "DecommissionAndRemoveInProgress", "DecommissionedForRemove" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode of the server.\n* `IntersightStandalone` - Intersight Standalone mode of operation.\n* `UCSM` - Unified Computing System Manager mode of operation.\n* `Intersight` - Intersight managed mode of operation.", "type": "string", "enum": [ "IntersightStandalone", "UCSM", "Intersight" ], "default": "IntersightStandalone", "x-omitempty": true }, "MemorySpeed": { "description": "The maximum memory speed in MHz available on the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "MgmtIpAddress": { "description": "Management address of the server.", "type": "string", "x-omitempty": true }, "Name": { "description": "The name of the UCS Fabric Interconnect cluster or Cisco Integrated Management Controller (CIMC). When this server is attached to a UCS Fabric Interconnect, the value of this property is the name of the UCS Fabric Interconnect along with chassis/server Id. When this server configured in standalone mode, the value of this property is the name of the Cisco Integrated Management Controller. when this server is configired in IMM mode, the value of this property contains model and chassis/server Id.", "type": "string", "x-omitempty": true }, "NumAdaptors": { "description": "The total number of network adapters present on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpuCores": { "description": "The total number of CPU cores present on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpuCoresEnabled": { "description": "The total number of CPU cores enabled on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpus": { "description": "The total number of CPUs present on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumEthHostInterfaces": { "description": "The total number of vNICs which are visible to a host on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumFcHostInterfaces": { "description": "The total number of vHBAs which are visible to a host on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumThreads": { "description": "The total number of threads the server is capable of handling.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "The actual power state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The oper reason status list of the server.\n* `Unknown` - The health message type is not known.\n* `WillBootError` - The compute object has ecountered a will boot error status.\n* `MemoryInoperable` - One or more memory units on this server are inoperable.\n* `ProcessorInoperable` - One or more processor units on this server are inoperable.\n* `DeprecatedAdapter` - One or more adapter units on this server are not supported or deprecated.\n* `PciNodeInserted` - One or more PCIe node are detected that are managed by this server.\n* `PciNodeRemoved` - One or more PCIe node got removed that were managed by this server.\n* `PowerCycleRequired` - One or more PCIe node are detected and a compute node power cycle is required to update inventory.\n* `PowerOnRequired` - One or more PCIe node are detected and a compute node power on is required to update inventory.\n* `PCIeNodeUnsupported` - Unsupported PCIe node detected.\n* `PCIeNodeUnidentified` - Unidentified PCIe node detected.\n* `BiosPostTimedOut` - BIOS POST completion timeout was detected on this server.\n* `SysThrottleCritical` - The health state of the server at the time of system throttling.\n* `SysThrottleWarning` - The health state of the server at the time of system throttling.\n* `UnauthorizedManagementVic` - The network adapter used for management traffic has been determined to be counterfeit.\n* `ZoneInactive` - The operReason of the compute blade will be set to this value if the mapped PCIe device is not available.\n* `MappedPCIeDevicesRemoved` - One or more mapped PCIe devices have been physically removed.\n* `MappedPCIeDeviceConnectionsRemoved` - One or more mapped PCIe device connectivity modules (X-Fabric module) have been physically removed.\n* `BladeReseatedWithPcieConnPolicy` - The blade was reseated and has a PCIe connectivity policy assigned. The PCIe connectivity configuration needs to be reapplied.\n* `BladeInReservedSlot` - The blade is inserted in a slot that is reserved for Secure Router.", "type": "string", "enum": [ "Unknown", "WillBootError", "MemoryInoperable", "ProcessorInoperable", "DeprecatedAdapter", "PciNodeInserted", "PciNodeRemoved", "PowerCycleRequired", "PowerOnRequired", "PCIeNodeUnsupported", "PCIeNodeUnidentified", "BiosPostTimedOut", "SysThrottleCritical", "SysThrottleWarning", "UnauthorizedManagementVic", "ZoneInactive", "MappedPCIeDevicesRemoved", "MappedPCIeDeviceConnectionsRemoved", "BladeReseatedWithPcieConnPolicy", "BladeInReservedSlot" ], "default": "Unknown", "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The operational state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "The operability of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type of the registered device - whether managed by UCSM or operating in standalone mode.", "type": "string", "x-omitempty": true }, "RecoveryKeyDetails": { "description": "The boot security key information of the current host operating system.", "$ref": "#/components/schemas/compute.RecoveryKeyDetails", "readOnly": true, "x-omitempty": true }, "ServiceProfile": { "description": "The distinguished name of the service profile to which the server is associated to. It is applicable only for servers which are managed via UCSM.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalMemory": { "description": "The total memory available on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TunneledKvm": { "description": "The Tunneled vKVM status of the server.", "type": "boolean", "x-omitempty": true }, "UserLabel": { "description": "The user defined label assigned to the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The universally unique identity of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "BootCddDevices": { "description": "An array of relationships to bootCddDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.CddDevice.Relationship" }, "nullable": true }, "BootDeviceBootSecurity": { "$ref": "#/components/schemas/boot.DeviceBootSecurity.Relationship", "description": "A reference to a bootDeviceBootSecurity resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BootHddDevices": { "description": "An array of relationships to bootHddDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.HddDevice.Relationship" }, "nullable": true }, "BootIscsiDevices": { "description": "An array of relationships to bootIscsiDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.IscsiDevice.Relationship" }, "nullable": true }, "BootNvmeDevices": { "description": "An array of relationships to bootNvmeDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.NvmeDevice.Relationship" }, "nullable": true }, "BootPchStorageDevices": { "description": "An array of relationships to bootPchStorageDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.PchStorageDevice.Relationship" }, "nullable": true }, "BootPxeDevices": { "description": "An array of relationships to bootPxeDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.PxeDevice.Relationship" }, "nullable": true }, "BootSanDevices": { "description": "An array of relationships to bootSanDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.SanDevice.Relationship" }, "nullable": true }, "BootSdDevices": { "description": "An array of relationships to bootSdDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.SdDevice.Relationship" }, "nullable": true }, "BootUefiShellDevices": { "description": "An array of relationships to bootUefiShellDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.UefiShellDevice.Relationship" }, "nullable": true }, "BootUsbDevices": { "description": "An array of relationships to bootUsbDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.UsbDevice.Relationship" }, "nullable": true }, "BootVmediaDevices": { "description": "An array of relationships to bootVmediaDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/boot.VmediaDevice.Relationship" }, "nullable": true }, "MgmtIdentity": { "$ref": "#/components/schemas/equipment.PhysicalIdentity.Relationship", "description": "A reference to a equipmentPhysicalIdentity resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Vmedia": { "$ref": "#/components/schemas/compute.Vmedia.Relationship", "description": "A reference to a computeVmedia resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "compute.PhysicalSummary.Response": { "description": "The response body of a HTTP GET request for the 'compute.PhysicalSummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.PhysicalSummary' resources.", "x-one-of-name": "compute.PhysicalSummary.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.PhysicalSummary.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.PhysicalSummary.Relationship": { "description": "A relationship to the 'compute.PhysicalSummary' resource, or the expanded 'compute.PhysicalSummary' resource, or the 'null' value.", "x-one-of-name": "compute.PhysicalSummary.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.PhysicalSummary" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.PhysicalSummary": { "title": "PhysicalSummary", "description": "The compute.PhysicalSummary object provides a consolidated, high-level view of a physical server, aggregating key information from both compute.Blade and compute.RackUnit objects. It is designed for efficient display and querying in user interfaces and summary dashboards.\n#### Purpose\nThe primary purpose of this object is to offer a flattened, easy-to-consume summary of a server's most important attributes. It combines identity, status, configuration, and capacity information into a single object, reducing the need to query multiple, more detailed objects for a high-level overview.\n#### Key Concepts\n- **Aggregated View:** Consolidates essential properties like name, model, serial, operPowerState, faultSummary, and totalMemory into one place.\n- **Unified Server Model:** Provides a consistent structure for both blade and rack servers, simplifying client-side logic for displaying server lists.\n- **Performance-Oriented:** Designed to be efficiently queried and indexed, making it ideal for populating dashboards and summary views with minimal latency.\n- **Link to Source:** The sourceObjectType property maintains a reference to the original, more detailed object (Blade or RackUnit), allowing for drill-down to more specific information.", "x-allOf-name": "compute.PhysicalSummary", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.PhysicalSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.PhysicalSummary" ], "default": "compute.PhysicalSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.PhysicalSummary" ], "default": "compute.PhysicalSummary", "x-enum-as-string": true }, "AdminPowerState": { "description": "The desired power state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AlarmSummary": { "description": "The summary of alarm counts based on alarm serverity.", "$ref": "#/components/schemas/compute.AlarmSummary", "readOnly": true, "x-omitempty": true }, "AssetTag": { "description": "The user defined asset tag assigned to the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AvailableMemory": { "description": "Total memeory of the server in MB.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "BiosPostComplete": { "description": "The BIOS POST completion status of the server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ChassisId": { "description": "The id of the chassis that the blade is discovered in.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Connectivity Status of RackUnit to Switch - A or B or AB.", "type": "string", "readOnly": true, "x-omitempty": true }, "CoolingMode": { "description": "Cooling mode representation of the server, supported modes include Air and Immersion.\n* `Air` - Cooling mode of the device is set to Air.\n* `Immersion` - Cooling mode of the device is set to Immersion.", "type": "string", "enum": [ "Air", "Immersion" ], "default": "Air", "readOnly": true, "x-omitempty": true }, "CpuCapacity": { "description": "Total processing capacity of the server.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DeviceMoId": { "description": "The MoId of the registered device that coresponds to the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The Distinguished Name unambiguously identifies an object in the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "FaultSummary": { "description": "The fault summary for the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Firmware": { "description": "The firmware version of the Cisco Integrated Management Controller (CIMC) for this server.", "type": "string", "readOnly": true, "x-omitempty": true }, "FrontPanelLockState": { "description": "The actual front panel state of the server.\n* `Unlock` - Front Panel of the server is set to Unlocked state.\n* `Lock` - Front Panel of the server is set to Locked state.", "type": "string", "enum": [ "Unlock", "Lock" ], "default": "Unlock", "x-omitempty": true }, "HardwareUuid": { "description": "The universally unique hardware identity of the server provided by the manufacturer.", "type": "string", "readOnly": true, "x-omitempty": true }, "HasE3SSupport": { "description": "The flag to indicate server has the support for E3.S drives.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Ipv4Address": { "description": "The IPv4 address configured on the management interface of the Integrated Management Controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsUpgraded": { "description": "This field indicates the compute status of the catalog values for the associated component or hardware.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KvmIpAddresses": { "type": "array", "items": { "description": "The list of KVM Ip addresses for the server.", "$ref": "#/components/schemas/compute.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "KvmServerStateEnabled": { "description": "The KVM server state of the server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "KvmVendor": { "description": "The KVM Vendor for the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastPowerStateChangedTime": { "description": "The Last host power state changed time of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Lifecycle": { "description": "The lifecycle of the blade server.\n* `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment.\n* `Active` - Default Lifecycle State for a physical entity.\n* `Decommissioned` - Decommission Lifecycle state.\n* `SlotReserved` - Blade is inserted in a slot that is reserved for Secure Router.\n* `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state.\n* `DiscoveryFailed` - DiscoveryFailed Lifecycle state.\n* `FirmwareUpgradeInProgress` - Firmware upgrade is in progress on given physical entity.\n* `DiagnosticsInProgress` - Diagnostics is in progress on given physical entity.\n* `SecureEraseInProgress` - Secure Erase is in progress on given physical entity.\n* `ScrubInProgress` - Scrub is in progress on given physical entity.\n* `BladeMigrationInProgress` - Server slot migration is in progress on given physical entity.\n* `SlotMismatch` - The blade server is detected in a different chassis/slot than it was previously.\n* `Removed` - The blade server has been removed from its discovered slot, and not detected anywhere else. Blade inventory can be cleaned up by performing a software remove operation on the physically removed blade.\n* `Moved` - The blade server has been moved from its discovered location to a new location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `Replaced` - The blade server has been removed from its discovered location and another blade has been inserted in that location. Blade inventory can be cleaned up and updated by doing a software remove operation on the physically removed blade.\n* `MovedAndReplaced` - The blade server has been moved from its discovered location to a new location and another blade has been inserted into the old discovered location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `DecommissionAndRemoveInProgress` - Decommission and remove operation is in progress.\n* `DecommissionedForRemove` - Server is decommissioned and once it is physically pulled from chassis, it will be automatically removed from inventory.", "type": "string", "enum": [ "None", "Active", "Decommissioned", "SlotReserved", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "DiagnosticsInProgress", "SecureEraseInProgress", "ScrubInProgress", "BladeMigrationInProgress", "SlotMismatch", "Removed", "Moved", "Replaced", "MovedAndReplaced", "DecommissionAndRemoveInProgress", "DecommissionedForRemove" ], "default": "None", "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "Location details associated with the managed object. When a top level resource (i.e., Unified Edge Chassis) is assigned to a location, the details of the associated location are propagated to related inventory and configuration objects like servers, profiles, alarms and metrics to facilitate location based filtering.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode of the server.\n* `IntersightStandalone` - Intersight Standalone mode of operation.\n* `UCSM` - Unified Computing System Manager mode of operation.\n* `Intersight` - Intersight managed mode of operation.", "type": "string", "enum": [ "IntersightStandalone", "UCSM", "Intersight" ], "default": "IntersightStandalone", "readOnly": true, "x-omitempty": true }, "MemorySpeed": { "description": "The maximum memory speed in MHz available on the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "MgmtIpAddress": { "description": "Management address of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field identifies the model of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the UCS Fabric Interconnect cluster or Cisco Integrated Management Controller (CIMC). When this server is attached to a UCS Fabric Interconnect, the value of this property is the name of the UCS Fabric Interconnect along with chassis/server Id. When this server configured in standalone mode, the value of this property is the name of the Cisco Integrated Management Controller. when this server is configired in IMM mode, the value of this property contains model and chassis/server Id.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumAdaptors": { "description": "The total number of network adapters present on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpuCores": { "description": "The total number of CPU cores enabled on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpuCoresEnabled": { "description": "The total number of CPU cores enabled on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCpus": { "description": "The total number of CPUs present on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumEthHostInterfaces": { "description": "The total number of vNICs which are visible to a host on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumFcHostInterfaces": { "description": "The total number of vHBAs which are visible to a host on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumThreads": { "description": "The total number of threads the server is capable of handling.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "The actual power state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The oper reason status list of the server.\n* `Unknown` - The health message type is not known.\n* `WillBootError` - The compute object has ecountered a will boot error status.\n* `MemoryInoperable` - One or more memory units on this server are inoperable.\n* `ProcessorInoperable` - One or more processor units on this server are inoperable.\n* `DeprecatedAdapter` - One or more adapter units on this server are not supported or deprecated.\n* `PciNodeInserted` - One or more PCIe node are detected that are managed by this server.\n* `PciNodeRemoved` - One or more PCIe node got removed that were managed by this server.\n* `PowerCycleRequired` - One or more PCIe node are detected and a compute node power cycle is required to update inventory.\n* `PowerOnRequired` - One or more PCIe node are detected and a compute node power on is required to update inventory.\n* `PCIeNodeUnsupported` - Unsupported PCIe node detected.\n* `PCIeNodeUnidentified` - Unidentified PCIe node detected.\n* `BiosPostTimedOut` - BIOS POST completion timeout was detected on this server.\n* `SysThrottleCritical` - The health state of the server at the time of system throttling.\n* `SysThrottleWarning` - The health state of the server at the time of system throttling.\n* `UnauthorizedManagementVic` - The network adapter used for management traffic has been determined to be counterfeit.\n* `ZoneInactive` - The operReason of the compute blade will be set to this value if the mapped PCIe device is not available.\n* `MappedPCIeDevicesRemoved` - One or more mapped PCIe devices have been physically removed.\n* `MappedPCIeDeviceConnectionsRemoved` - One or more mapped PCIe device connectivity modules (X-Fabric module) have been physically removed.\n* `BladeReseatedWithPcieConnPolicy` - The blade was reseated and has a PCIe connectivity policy assigned. The PCIe connectivity configuration needs to be reapplied.\n* `BladeInReservedSlot` - The blade is inserted in a slot that is reserved for Secure Router.", "type": "string", "enum": [ "Unknown", "WillBootError", "MemoryInoperable", "ProcessorInoperable", "DeprecatedAdapter", "PciNodeInserted", "PciNodeRemoved", "PowerCycleRequired", "PowerOnRequired", "PCIeNodeUnsupported", "PCIeNodeUnidentified", "BiosPostTimedOut", "SysThrottleCritical", "SysThrottleWarning", "UnauthorizedManagementVic", "ZoneInactive", "MappedPCIeDevicesRemoved", "MappedPCIeDeviceConnectionsRemoved", "BladeReseatedWithPcieConnPolicy", "BladeInReservedSlot" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The operational state of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "The operability of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PackageVersion": { "description": "Bundle version which the firmware belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "Personality": { "description": "Unique identity of added software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type of the registered device - whether managed by UCSM or operating in standalone mode.", "type": "string", "readOnly": true, "x-omitempty": true }, "Presence": { "description": "This field identifies the presence (equipped) or absence of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "Revision": { "description": "This field identifies the revision of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "Rn": { "description": "The Relative Name uniquely identifies an object within a given context.", "type": "string", "readOnly": true, "x-omitempty": true }, "ScaledMode": { "description": "The mode of the server that determines it is scaled.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "This field identifies the serial of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerId": { "description": "RackUnit ID that uniquely identifies the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ServiceProfile": { "description": "The distinguished name of the service profile to which the server is associated to. It is applicable only for servers which are managed via UCSM.", "type": "string", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "The slot number in the chassis that the blade is discovered in.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SourceObjectType": { "description": "Stores the source object type. This feild will either be RackUnit or Blade.", "type": "string", "readOnly": true, "x-omitempty": true }, "TopologyScanStatus": { "description": "To maintain the Topology workflow run status.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalMemory": { "description": "The total memory available on the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TunneledKvm": { "description": "The Tunneled vKVM status of the server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "UserLabel": { "description": "The user defined label assigned to the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The universally unique identity of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "This field identifies the vendor of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryParent": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.PhysicalSummary.List": { "title": "List of 'compute.PhysicalSummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.PhysicalSummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.PhysicalSummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.PhysicalSummary" }, "nullable": true } } } ] }, "compute.RackUnit.Response": { "description": "The response body of a HTTP GET request for the 'compute.RackUnit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.RackUnit' resources.", "x-one-of-name": "compute.RackUnit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.RackUnit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.RackUnit.Relationship": { "description": "A relationship to the 'compute.RackUnit' resource, or the expanded 'compute.RackUnit' resource, or the 'null' value.", "x-one-of-name": "compute.RackUnit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.RackUnit" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.RackUnit": { "title": "Compute:Rack Unit", "description": "The compute.RackUnit object represents a standalone or FI-attached rack-mounted server. It is a primary inventory object that encapsulates the server's identity, hardware components, operational status, and management details.\n#### Purpose\nThe compute.RackUnit object serves as the central management and inventory entity for a rack server. This provides a comprehensive, queryable model of the server, from its physical hardware (motherboard, adapters, PSUs, fans) to its management state (IP address, management mode). It is the foundation for all management operations performed on the server.\n#### Key Concepts\n- **Comprehensive Inventory:** Acts as the top-level container for all of the rack server's hardware components, including compute.Board, adapter.Unit, storage.Controller, and equipment.Psu.\n- **Management State:** Captures key management details, including its managementMode (e.g., IntersightStandalone), mgmtIpAddress, and connectivity status.\n- **Unique Identification:** Uniquely identified by its serial number and a system-assigned serverId.\n- **Topology Awareness:** The topologyScanStatus and connectionStatus properties track its connectivity to upstream switches, providing insight into the network topology.", "x-allOf-name": "compute.RackUnit", "allOf": [ { "$ref": "#/components/schemas/compute.Physical" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.RackUnit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.RackUnit" ], "default": "compute.RackUnit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.RackUnit" ], "default": "compute.RackUnit", "x-enum-as-string": true }, "AdminAction": { "description": "Updated by UI/API to trigger specific action type.\n* `None` - No operation value for maintenance actions on an equipment.\n* `Reack` - Reacknowledge the equipment and discover it again.", "type": "string", "enum": [ "None", "Reack" ], "default": "None", "x-omitempty": true }, "ConnectionStatus": { "description": "Connectivity Status of RackUnit to Switch - A or B or AB.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "Location details associated with the managed object. When a top level resource (i.e., Unified Edge Chassis) is assigned to a location, the details of the associated location are propagated to related inventory and configuration objects like servers, profiles, alarms and metrics to facilitate location based filtering.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "ServerId": { "description": "RackUnit ID that uniquely identifies the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TopologyScanStatus": { "description": "To maintain the Topology workflow run status.", "type": "string", "x-omitempty": true }, "Adapters": { "description": "An array of relationships to adapterUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.Unit.Relationship" }, "nullable": true, "readOnly": true }, "AssignedLocation": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.GeoLocation.Relationship", "description": "A reference to a assetGeoLocation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BiosBootmode": { "$ref": "#/components/schemas/bios.BootMode.Relationship", "description": "A reference to a biosBootMode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BiosTokenSettings": { "$ref": "#/components/schemas/bios.TokenSettings.Relationship", "description": "A reference to a biosTokenSettings resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BiosVfSelectMemoryRasConfiguration": { "$ref": "#/components/schemas/bios.VfSelectMemoryRasConfiguration.Relationship", "description": "A reference to a biosVfSelectMemoryRasConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Biosunits": { "deprecated": true, "x-sunset": "2027-03-01", "description": "An array of relationships to biosUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/bios.Unit.Relationship" }, "nullable": true, "readOnly": true }, "Bmc": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Board": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "BootDeviceBootmode": { "$ref": "#/components/schemas/boot.DeviceBootMode.Relationship", "description": "A reference to a bootDeviceBootMode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputePersonality": { "description": "An array of relationships to computePersonality resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Personality.Relationship" }, "nullable": true, "readOnly": true }, "ComputeServerPowerParameters": { "$ref": "#/components/schemas/compute.ServerPowerParameters.Relationship", "description": "A reference to a computeServerPowerParameters resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentEnclosureElements": { "description": "An array of relationships to equipmentEnclosureElement resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.EnclosureElement.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentRisers": { "description": "An array of relationships to equipmentRiser resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Riser.Relationship" }, "nullable": true, "readOnly": true }, "Fanmodules": { "description": "An array of relationships to equipmentFanModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule.Relationship" }, "nullable": true, "readOnly": true }, "GenericInventoryHolders": { "description": "An array of relationships to inventoryGenericInventoryHolder resources.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder.Relationship" }, "nullable": true, "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true }, "HybridDriveSlots": { "description": "An array of relationships to equipmentHybridDriveSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.HybridDriveSlot.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryArrays": { "description": "An array of relationships to memoryArray resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Array.Relationship" }, "nullable": true }, "PciDevices": { "description": "An array of relationships to pciDevice resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Device.Relationship" }, "nullable": true, "readOnly": true }, "PciSlots": { "description": "An array of relationships to pciSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Slot.Relationship" }, "nullable": true, "readOnly": true }, "Processors": { "description": "An array of relationships to processorUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/processor.Unit.Relationship" }, "nullable": true }, "Psus": { "description": "An array of relationships to equipmentPsu resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Psu.Relationship" }, "nullable": true, "readOnly": true }, "RackEnclosureSlot": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot.Relationship", "description": "A reference to a equipmentRackEnclosureSlot resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SasExpanders": { "description": "An array of relationships to storageSasExpander resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.SasExpander.Relationship" }, "nullable": true }, "StorageControllers": { "description": "An array of relationships to storageController resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Controller.Relationship" }, "nullable": true }, "StorageEnclosures": { "description": "An array of relationships to storageEnclosure resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Enclosure.Relationship" }, "nullable": true, "readOnly": true }, "TopSystem": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/top.System.Relationship", "description": "A reference to a topSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UnitPersonality": { "description": "An array of relationships to rackUnitPersonality resources.", "type": "array", "items": { "$ref": "#/components/schemas/rack.UnitPersonality.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "compute.RackUnit.List": { "title": "List of 'compute.RackUnit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.RackUnit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.RackUnit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.RackUnit" }, "nullable": true } } } ] }, "compute.RackUnitIdentity.Response": { "description": "The response body of a HTTP GET request for the 'compute.RackUnitIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.RackUnitIdentity' resources.", "x-one-of-name": "compute.RackUnitIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.RackUnitIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.RackUnitIdentity": { "title": "Rack Server Identity Information", "description": "The RackUnitIdentity object defines the identity of a rack-mount server under device registration. It abstracts the core attributes needed to manage and monitor rack servers, providing a uniform handle for automation, discovery, and configuration workflows.\n#### Purpose \nA RackUnitIdentity acts as the primary identity anchor for rack servers, enabling inventory collection and synchronization of rack-mount systems, triggering discovery, decommission, and profile-deployment workflows, and providing a consistent reference point for policy application and audit trails.\n#### Key Concepts \n- **Device Registration Linkage:** Associates the rack server to its controlling device registration endpoint. \n- **Global Uniqueness:** Combines vendor/model/serial with registration context to avoid identity collisions. \n- **Workflow Triggers:** Serves as the input/output reference for discovery and post-discovery actions. \n- **Abstraction Layer:** Hides low-level hardware details, exposing a simple identity for configuration tools.", "x-allOf-name": "compute.RackUnitIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.PhysicalIdentity" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.RackUnitIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.RackUnitIdentity" ], "default": "compute.RackUnitIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.RackUnitIdentity" ], "default": "compute.RackUnitIdentity", "x-enum-as-string": true }, "AdapterSerial": { "description": "Serial Identifier of an adapter participating in SWM.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "compute.RackUnitIdentity.List": { "title": "List of 'compute.RackUnitIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.RackUnitIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.RackUnitIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.RackUnitIdentity" }, "nullable": true } } } ] }, "compute.RecoveryKeyDetails": { "title": "Compute:Recovery Key Details", "description": "Migration Key Information of the server.", "x-allOf-name": "compute.RecoveryKeyDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.RecoveryKeyDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.RecoveryKeyDetails" ], "default": "compute.RecoveryKeyDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.RecoveryKeyDetails" ], "default": "compute.RecoveryKeyDetails", "x-enum-as-string": true }, "RecoveryKeyEndPointState": { "description": "Recovery key state as per the last endpoint notification.\n* `0` - Migration key retrieval unsupported on the platform, typically due to incompatible server firmware.\n* `1` - Recovery key collection timed out. Review support documentation, fix any issue, and re-trigger Server Profile deployment.\n* `2` - Recovery key collection failed. Review support documentation, fix any issue, and re-trigger Server Profile deployment.\n* `3` - Recovery key rotation timed out. Review support documentation, fix any issue, and re-trigger Server Profile deployment.\n* `4` - Recovery key rotation failed. Review support documentation, fix any issue, and re-trigger Server Profile deployment.\n* `5` - Recovery key is not purged at enpoint.\n* `6` - Recovery key available for retrieval from the endpoint.", "type": "integer", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "default": 0, "readOnly": true, "x-omitempty": true }, "RecoveryKeyInfo": { "description": "Recovery key and its associated details shared by the endpoint.", "$ref": "#/components/schemas/compute.MigrationKeyInfo", "readOnly": true, "x-omitempty": true }, "RecoveryKeyState": { "description": "Recovery key state is deduced based on the endpoint info and its associated server profile.\n* `KeyNotApplicable` - Recovery key retrieval not applicable on this platform, typically because recovery key collection is not enabled.\n* `KeyNotSupported` - Recovery key retrieval not supported on this platform, typically because server firmware does not support key retrieval.\n* `KeyNotAvailable` - Recovery key has not been collected from end-point. Review support documentation for any issues.\n* `WaitingForKey` - Recovery key rotation in progress. The server boots with the old key, then stores the new key in Intersight. After completion, the state changes to KeyAvailable.\n* `KeyOutOfSync` - Server assignment changed after key availability, causing a recovery key mismatch. Run Server Profile Activate to start key rotation.\n* `KeyAvailable` - Recovery key successfully fetched and securely stored in Intersight.", "type": "string", "enum": [ "KeyNotApplicable", "KeyNotSupported", "KeyNotAvailable", "WaitingForKey", "KeyOutOfSync", "KeyAvailable" ], "default": "KeyNotApplicable", "readOnly": true, "x-omitempty": true } } } ] }, "compute.RootPcieEndpointConfig": { "title": "Compute:Root Pcie Endpoint Config", "description": "Common properties for all PCIe initiator objects. Serves as the base class for all root PCIe endpoint types.", "x-allOf-name": "compute.RootPcieEndpointConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.RootPcieEndpointConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.CpuConfig" ], "default": "compute.CpuConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.CpuConfig" ], "default": "compute.CpuConfig", "x-enum-as-string": true }, "RootPcieEndpointType": { "description": "Type of root PCIe endpoint device.\n* `CPU` - The root PCIe endpoint type is CPU.", "type": "string", "enum": [ "CPU" ], "default": "CPU", "x-omitempty": true } } } ] }, "compute.ScrubOpConfigutation": { "title": "Scrub Configuration", "description": "Scrub configutation used to specify the components to clear.", "x-allOf-name": "compute.ScrubOpConfigutation", "allOf": [ { "$ref": "#/components/schemas/compute.HostUtilityOperationConfguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ScrubOpConfigutation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ScrubOpConfigutation" ], "default": "compute.ScrubOpConfigutation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ScrubOpConfigutation" ], "default": "compute.ScrubOpConfigutation", "x-enum-as-string": true }, "ScrubTargets": { "type": "array", "items": { "description": "Collection of scrub targets to cleanup data. Data cleanup is initiated on these specified targets during Scrub.\n* `Disk` - Data is erased from all the local stroages, if specified in the scrub policy.\n* `BIOS` - BIOS will be reset to factory defaults, if speficied in the scrub policy.", "type": "string", "enum": [ "Disk", "BIOS" ], "default": "Disk", "x-omitempty": true }, "nullable": true } } } ] }, "compute.ScrubPolicy.Response": { "description": "The response body of a HTTP GET request for the 'compute.ScrubPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.ScrubPolicy' resources.", "x-one-of-name": "compute.ScrubPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.ScrubPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.ScrubPolicy": { "title": "Scrub", "description": "The ScrubPolicy object defines the parameters for data cleanup on servers, particularly during server profile undeployments. It ensures that server components are effectively scrubbed as per configuration.\n#### Purpose\nScrubPolicy provides a framework for executing data cleanup tasks during server profile operations, safeguarding data integrity and compliance with policies. It plays a critical role in managing server disassociations.\n#### Key Concepts\n- **Policy Definition:** Sets clear guidelines for scrub operations, detailing which components should be cleaned during undeployments.\n- **Integration:** Links with server profiles to ensure scrub operations are executed as part of broader server management tasks.\n- **Security and Compliance:** Supports compliance by ensuring data cleanup is performed consistently and securely.\n- **Access Control:** Establishes privilege sets for policy management, ensuring controlled access to scrub configurations.", "x-allOf-name": "compute.ScrubPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ScrubPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ScrubPolicy" ], "default": "compute.ScrubPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ScrubPolicy" ], "default": "compute.ScrubPolicy", "x-enum-as-string": true }, "ScrubTargets": { "type": "array", "items": { "description": "Target components to be cleared during scrub.\n* `Disk` - Data is erased from all the local stroages, if specified in the scrub policy.\n* `BIOS` - BIOS will be reset to factory defaults, if speficied in the scrub policy.", "type": "string", "enum": [ "Disk", "BIOS" ], "default": "Disk", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "compute.ScrubPolicy.List": { "title": "List of 'compute.ScrubPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.ScrubPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.ScrubPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.ScrubPolicy" }, "nullable": true } } } ] }, "compute.ServerConfig": { "title": "Compute:Server Config", "description": "Configurable properties of servers common to both a server and a server profile. The user will apply these properties on a server directly when the server is not associated with a server profile and through a server profile when the server is attached with a server profile.", "x-allOf-name": "compute.ServerConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerConfig" ], "default": "compute.ServerConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerConfig" ], "default": "compute.ServerConfig", "x-enum-as-string": true }, "AssetTag": { "description": "User defined asset tag of the server.", "type": "string", "pattern": "^[ #$%\\(\\)\\*\\+,\\-\\.\\/:;\\|\\?@\\[\\]_\\{\\}\\^\\`\\>\\<~a-zA-Z0-9]*$", "minLength": 0, "maxLength": 32, "x-omitempty": true }, "UserLabel": { "description": "User defined description of the server.", "type": "string", "pattern": "^[ !#$%&\\(\\)\\*\\+,\\-\\.\\/:;\\|\\?@\\[\\]_\\{\\}~a-zA-Z0-9]*$", "minLength": 0, "maxLength": 64, "x-omitempty": true } } } ] }, "compute.ServerIdPool.Response": { "description": "The response body of a HTTP GET request for the 'compute.ServerIdPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.ServerIdPool' resources.", "x-one-of-name": "compute.ServerIdPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.ServerIdPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.ServerIdPool": { "title": "Compute:Server Id Pool", "description": "Identifier pool that generates a unique number for a server object.", "x-allOf-name": "compute.ServerIdPool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/sw.IdPoolBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerIdPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerIdPool" ], "default": "compute.ServerIdPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerIdPool" ], "default": "compute.ServerIdPool", "x-enum-as-string": true }, "PreferredIds": { "type": "array", "items": { "description": "Preferred Ids to be configured for connected devices like rack unit. User specifies these Ids in the port policy and these Ids are copied here on the Domain profile deployment.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.ServerIdPool.List": { "title": "List of 'compute.ServerIdPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.ServerIdPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.ServerIdPool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.ServerIdPool" }, "nullable": true } } } ] }, "compute.ServerOpStatus": { "title": "Compute:Server Op Status", "description": "The running workflow details for each server operation that can be performed on the servers.", "x-allOf-name": "compute.ServerOpStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerOpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerOpStatus" ], "default": "compute.ServerOpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerOpStatus" ], "default": "compute.ServerOpStatus", "x-enum-as-string": true }, "ConfigState": { "description": "The configured state of these settings in the target server. The value is any one of Applied, Applying, Failed. Applied - The state denotes that the settings are applied successfully in the target server. Applying - The state denotes that the settings are being applied in the target server. Failed - The state denotes that the settings could not be applied in the target server.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Scheduled` - User configured settings are scheduled to be applied.\n* `Failed` - User configured settings could not be applied.", "type": "string", "enum": [ "Applied", "Applying", "Scheduled", "Failed" ], "default": "Applied", "x-omitempty": true }, "WorkflowInfoMoid": { "description": "The WorkflowInfoMo moid that is running.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type being started. The workflow name to distinguish workflow by type.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "compute.ServerPowerParameters.Response": { "description": "The response body of a HTTP GET request for the 'compute.ServerPowerParameters' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.ServerPowerParameters' resources.", "x-one-of-name": "compute.ServerPowerParameters.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.ServerPowerParameters.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.ServerPowerParameters.Relationship": { "description": "A relationship to the 'compute.ServerPowerParameters' resource, or the expanded 'compute.ServerPowerParameters' resource, or the 'null' value.", "x-one-of-name": "compute.ServerPowerParameters.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.ServerPowerParameters" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.ServerPowerParameters": { "title": "Compute:Server Power Parameters", "description": "The compute.ServerPowerParameters object is a managed object used to inventory and track key power-related settings and parameters for a server.\n#### Purpose\nThe primary purpose of this object is to provide a centralized view of a server's power configuration and status. It consolidates several important power settings, such as the allocated power budget, the power restore policy, and the status of power profiling. This allows administrators to monitor and verify the power management configuration of their servers.\n#### Key Concepts\n- **Power Budgeting:** The powerAllocation property shows the maximum power in Watts that has been allocated to the server by a chassis management controller (CMC).\n- **Power Restore Policy:** The powerRestore property indicates what the server will do after a power loss event (e.g., \"Always On\", \"Last State\"), which is critical for service recovery.\n- **Advanced Power Management:** Tracks the status of modern power features like powerProfiling (for determining power needs) and processorPackagePowerLimit (for CPU power capping).\n- **Prioritization:** The powerPriority property shows the server's priority level (Low, Medium, High), which influences its initial power allocation in a power-constrained chassis.", "x-allOf-name": "compute.ServerPowerParameters", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerPowerParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerPowerParameters" ], "default": "compute.ServerPowerParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerPowerParameters" ], "default": "compute.ServerPowerParameters", "x-enum-as-string": true }, "PowerAllocation": { "description": "This field identifies the maximum power that has been allocated to the blade by CMC in Watts. Power budget for the chassis is configured by the power policy. That budget is then divided among the blades in the chassis by CMC.", "type": "integer", "format": "int64", "default": 0, "readOnly": true, "x-omitempty": true }, "PowerPriority": { "description": "Power Priority level of the Server. This priority is used to determine the initial power allocation for servers. This field is only supported for Cisco UCS B series and X series servers.\n* `Unknown` - Power allocation priority of server is either unknown or not supported on CMC firmware version.\n* `Low` - Power allocation priority of server is low.\n* `Medium` - Power allocation priority of server is medium.\n* `High` - Power allocation priority of server is high.", "type": "string", "enum": [ "Unknown", "Low", "Medium", "High" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "PowerProfiling": { "description": "Status of Power Profiling setting of the Server. If Enabled, this field allows the power manager to run power profiling utility to determine the power needs of the server. This field is only supported for Cisco UCS X series servers.\n* `Unknown` - Power Profiling state is either unknown for the server or not supported on BMC firmware version.\n* `Enabled` - Power Profiling is enabled for the server.\n* `Disabled` - Power Profiling is either disabled for the server or not supported on BMC firmware version.", "type": "string", "enum": [ "Unknown", "Enabled", "Disabled" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "PowerRestore": { "description": "Value of the power restore policy for the server. In the absence of Intersight connectivity, the server will use this state to recover the host power after a power loss event.\n* `Unknown` - Power restore state for the server is either Unknown or not supported on BMC firmware version.\n* `Always On` - Power restore state for server is set to Always On.\n* `Always Off` - Power restore state for server is set to Always Off.\n* `Last State` - Power restore state for server is set to Last State.", "type": "string", "enum": [ "Unknown", "Always On", "Always Off", "Last State" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ProcessorPackagePowerLimit": { "description": "Processor Package Power Limit (PPL) of a server. PPL refers to the amount of power that a CPU can draw from the power supply. The Processor Package Power Limit (PPL) feature is currently available exclusively on Cisco UCS C225/C245 M8 servers.\n* `Unknown` - Processor package power limit is either unknown for the server or not supported on BMC firmware version.\n* `Default` - Processor package power limit is default for the server.\n* `Maximum` - Processor package power limit is maximum for the server.\n* `Minimum` - Processor package power limit is minimum for the server.", "type": "string", "enum": [ "Unknown", "Default", "Maximum", "Minimum" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.ServerPowerParameters.List": { "title": "List of 'compute.ServerPowerParameters' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.ServerPowerParameters' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.ServerPowerParameters' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.ServerPowerParameters" }, "nullable": true } } } ] }, "compute.ServerPowerPolicy.Response": { "description": "The response body of a HTTP GET request for the 'compute.ServerPowerPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.ServerPowerPolicy' resources.", "x-one-of-name": "compute.ServerPowerPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.ServerPowerPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.ServerPowerPolicy": { "title": "Apply Server Power Policy", "description": "The ServerPowerPolicy object dictates the power tasks required during server profile deployments and undeployments. It helps manage server power states according to the defined policy.\n#### Purpose\nServerPowerPolicy serves as a guideline for determining server power actions, such as power on/off, during server profile operations. It ensures that power state changes are managed consistently and according to policy.\n#### Key Concepts\n- **Policy Definition:** Establishes rules for server power management during profile operations, providing clarity and consistency.\n- **Integration with Profiles:** Connects with server profiles to ensure power policies are applied as part of broader management tasks.\n- **Access Control:** Uses privilege sets to manage policy updates, supporting secure and controlled access.\n- **Relationship Management:** Links with registered devices and servers, ensuring power policies are enforced across the network.", "x-allOf-name": "compute.ServerPowerPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerPowerPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerPowerPolicy" ], "default": "compute.ServerPowerPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerPowerPolicy" ], "default": "compute.ServerPowerPolicy", "x-enum-as-string": true }, "PowerState": { "description": "User configured power state of server.\n* `Policy` - Power state is set to the default value in the policy.\n* `PowerOn` - Power state of the server is set to On.\n* `PowerOff` - Power state is the server set to Off.\n* `PowerCycle` - Power state the server is reset.\n* `HardReset` - Power state the server is hard reset.\n* `Shutdown` - Operating system on the server is shut down.\n* `Reboot` - Power state of IMC is rebooted.", "type": "string", "enum": [ "Policy", "PowerOn", "PowerOff", "PowerCycle", "HardReset", "Shutdown", "Reboot" ], "default": "Policy", "x-omitempty": true }, "ServerName": { "description": "The name of the server it is associated with.", "type": "string", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.ServerPowerPolicy.List": { "title": "List of 'compute.ServerPowerPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.ServerPowerPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.ServerPowerPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.ServerPowerPolicy" }, "nullable": true } } } ] }, "compute.ServerSetting.Response": { "description": "The response body of a HTTP GET request for the 'compute.ServerSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.ServerSetting' resources.", "x-one-of-name": "compute.ServerSetting.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.ServerSetting.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.ServerSetting": { "title": "Server Settings", "description": "The ServerSetting object models the configurable properties of a server within Cisco's Intersight platform. This provides a comprehensive interface for managing server settings and operations.\n#### Purpose\nServerSetting enables users to configure various server properties, such as power state, locator led and TPM actions, directly from Intersight. It supports server management tasks by offering a unified configuration model.\n#### Key Concepts\n- **Configuration Management:** Allows configuration of server settings, such as power state and asset tags, enhancing server management capabilities.\n- **Integration with Devices:** Links with device endpoints to ensure settings are applied correctly across the network.\n- **Access Control** Utilizes privilege sets to manage read and update operations, supporting secure server management.\n- **Relationship Management:** Connects with related objects like locator LEDs and storage operations for cohesive configuration management.", "x-allOf-name": "compute.ServerSetting", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.ServerSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.ServerSetting" ], "default": "compute.ServerSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.ServerSetting" ], "default": "compute.ServerSetting", "x-enum-as-string": true }, "AdminLocatorLedState": { "description": "User configured state of the locator LED for the server.\n* `None` - No operation property for locator led.\n* `On` - The Locator Led is turned on.\n* `Off` - The Locator Led is turned off.", "type": "string", "enum": [ "None", "On", "Off" ], "default": "None", "x-omitempty": true }, "AdminPowerState": { "description": "User configured power state of the server.\n* `Policy` - Power state is set to the default value in the policy.\n* `PowerOn` - Power state of the server is set to On.\n* `PowerOff` - Power state is the server set to Off.\n* `PowerCycle` - Power state the server is reset.\n* `HardReset` - Power state the server is hard reset.\n* `Shutdown` - Operating system on the server is shut down.\n* `Reboot` - Power state of IMC is rebooted.", "type": "string", "enum": [ "Policy", "PowerOn", "PowerOff", "PowerCycle", "HardReset", "Shutdown", "Reboot" ], "default": "Policy", "x-omitempty": true }, "CertificatesAction": { "description": "Certificates Action configures the Certificate and PrivateKey at the endpoint.", "$ref": "#/components/schemas/certificatemanagement.CertificateBase", "x-omitempty": true }, "ClearSel": { "description": "Clear system event log on a server.\n* `Ready` - Clear system event log operation is allowed on the server in this state.\n* `Clear` - Trigger a clear system event log operation on a server.", "type": "string", "enum": [ "Ready", "Clear" ], "default": "Ready", "x-omitempty": true }, "CmosReset": { "description": "The allowed actions on the CMOS Reset.\n* `Ready` - CMOS Reset operation is allowed to be done on the server in this state.\n* `Pending` - The identifier to state that the previous CMOS Reset operation on this server has not completed due to a pending power cycle. CMOS Reset operation cannot be done on the server when in this state.\n* `Reset` - The value that the UI/API needs to provide to trigger a CMOS Reset operation on a server.", "type": "string", "enum": [ "Ready", "Pending", "Reset" ], "default": "Ready", "x-omitempty": true }, "CollectSel": { "description": "Collect system event log from a server.\n* `Ready` - Collect system event log operation is allowed on the server in this state.\n* `Collect` - Trigger a collect system event log operation on a server.", "type": "string", "enum": [ "Ready", "Collect" ], "default": "Ready", "x-omitempty": true }, "ConfigState": { "description": "The configured state of these settings in the target server. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target server. Applying - This state denotes that the settings are being applied in the target server. Failed - This state denotes that the settings could not be applied in the target server.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Scheduled` - User configured settings are scheduled to be applied.\n* `Failed` - User configured settings could not be applied.", "type": "string", "enum": [ "Applied", "Applying", "Scheduled", "Failed" ], "default": "Applied", "readOnly": true, "x-omitempty": true }, "FrontPanelLockState": { "description": "The allowed actions on the Front Panel Lock.\n* `None` - Front Panel of the server is set to None state. It is required so that the next frontPanelLockState operation can be triggered.\n* `Lock` - Front Panel of the server is set to Locked state.\n* `Unlock` - Front Panel of the server is set to Unlocked state.", "type": "string", "enum": [ "None", "Lock", "Unlock" ], "default": "None", "x-omitempty": true }, "HostInitConfiguration": { "description": "The JSON formatted host initialization configuration containing the basic information for doing an initial boot. The information will be sent to CIMC and stored in host-init.json file on the server. The stored file can only be access using IPMI tool on the host OS.", "type": "string", "writeOnly": true, "x-omitempty": true }, "KvmReset": { "description": "The allowed actions on the vKVM Reset.\n* `Ready` - Reset vKVM operation is allowed to be done on the server in this state.\n* `Reset` - The value that the UI/API needs to provide to trigger a Reset vKVM operation on a server.", "type": "string", "enum": [ "Ready", "Reset" ], "default": "Ready", "x-omitempty": true }, "Name": { "description": "The property used to identify the name of the server it is associated with.", "type": "string", "readOnly": true, "x-omitempty": true }, "OneTimeBootDevice": { "description": "The name of the device chosen by user for configuring One-Time Boot device.", "type": "string", "x-omitempty": true }, "PersistentMemoryOperation": { "description": "The Persistent Memory Modules operation properties.", "$ref": "#/components/schemas/compute.PersistentMemoryOperation", "x-omitempty": true }, "PersonalitySetting": { "description": "The personality value to be set on the server. Any additional information like the hypervisor type, last update time can also be set through this server setting.", "$ref": "#/components/schemas/compute.PersonalitySetting", "writeOnly": true, "x-omitempty": true }, "ResetMemoryErrors": { "description": "Reset Correctable and Uncorrectable ECC errors on all the DIMMs present in the server.\n* `Ready` - Reset memory errors operation is allowed on the server in this state.\n* `Reset` - Trigger reset memory errors operation on a server.", "type": "string", "enum": [ "Ready", "Reset" ], "default": "Ready", "x-omitempty": true }, "ServerConfig": { "description": "The common server configurable properties between a server and a server profile.", "$ref": "#/components/schemas/compute.ServerConfig", "x-omitempty": true }, "ServerOpStatus": { "type": "array", "items": { "description": "The status of actions triggered on the server.", "$ref": "#/components/schemas/compute.ServerOpStatus", "x-omitempty": true }, "nullable": true }, "StorageControllerOperation": { "description": "The Storage Controller operation properties.", "$ref": "#/components/schemas/compute.StorageControllerOperation", "x-omitempty": true }, "StoragePhysicalDriveOperation": { "description": "The Storage Physical Drives operation properties.", "$ref": "#/components/schemas/compute.StoragePhysicalDriveOperation", "x-omitempty": true }, "StorageUtilityImageOperation": { "description": "The storage utility image operation properties.", "$ref": "#/components/schemas/compute.StorageUtilityImageOperation", "x-omitempty": true }, "StorageVirtualDriveOperation": { "description": "The Storage Virtual Drives operation properties.", "$ref": "#/components/schemas/compute.StorageVirtualDriveOperation", "x-omitempty": true }, "TpmReset": { "description": "Clear the configuration of TPM chip in the server.\n* `None` - Perform no action on the TPM.\n* `ClearTpm` - Clear the configuration and restore factory defaults of TPM chip in the server.", "type": "string", "enum": [ "None", "ClearTpm" ], "default": "None", "x-omitempty": true }, "TunneledKvmState": { "description": "By default, the tunneled vKVM property appears in Ready state. The property can be configured by performing allowed actions. Once the property is configured, it reverts to Ready state.\n* `Ready` - Tunneled vKVM is ready to be configured on the server.\n* `Enable` - Tunneled vKVM is enabled for the server.\n* `Disable` - Tunneled vKVM is disabled for the server.", "type": "string", "enum": [ "Ready", "Enable", "Disable" ], "default": "Ready", "x-omitempty": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningWorkflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.ServerSetting.List": { "title": "List of 'compute.ServerSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.ServerSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.ServerSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.ServerSetting" }, "nullable": true } } } ] }, "compute.StorageControllerOperation": { "title": "Compute:Storage Controller Operation", "description": "The operation that can be performed on the Storage Controller on the servers.", "x-allOf-name": "compute.StorageControllerOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StorageControllerOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StorageControllerOperation" ], "default": "compute.StorageControllerOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StorageControllerOperation" ], "default": "compute.StorageControllerOperation", "x-enum-as-string": true }, "AdminAction": { "description": "Administrative actions that can be performed on the Storage Controller.\n* `None` - No action on the selected Storage Controller.\n* `Import` - Import Foreign config action on the selected Storage Controller.\n* `Clear` - Clear Foreign config action on the selected Storage Controller.\n* `ClearConfig` - Clear Config action on the selected Storage Controller.\n* `ModifySecurity` - Modify Security on the selected Storage Controller.\n* `DisableSecurity` - Disable Security on the selected Storage Controller.\n* `UnlockDrives` - Set Unlock action state on the selected Storage Controller.", "type": "string", "enum": [ "None", "Import", "Clear", "ClearConfig", "ModifySecurity", "DisableSecurity", "UnlockDrives" ], "default": "None", "x-omitempty": true }, "ControllerId": { "description": "Storage Controller Id of the server.", "type": "string", "x-omitempty": true }, "EncryptionKey": { "description": "EncryptionKey of the Storage Controller.", "type": "string", "minLength": 0, "maxLength": 32, "x-omitempty": true }, "RemoteMode": { "description": "RemoteMode on the Storage Controller.", "type": "boolean", "x-omitempty": true } } } ] }, "compute.StoragePhysicalDrive": { "title": "Compute:Storage Physical Drive", "description": "Storage Physical Drives on which an operation has to be performed.", "x-allOf-name": "compute.StoragePhysicalDrive", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StoragePhysicalDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StoragePhysicalDrive" ], "default": "compute.StoragePhysicalDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StoragePhysicalDrive" ], "default": "compute.StoragePhysicalDrive", "x-enum-as-string": true }, "SlotNumber": { "description": "Physical Drive ID of the storage on the server.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "compute.StoragePhysicalDriveOperation": { "title": "Compute:Storage Physical Drive Operation", "description": "The operation that can be performed on the Storage Physical Drives on the servers.", "x-allOf-name": "compute.StoragePhysicalDriveOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StoragePhysicalDriveOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StoragePhysicalDriveOperation" ], "default": "compute.StoragePhysicalDriveOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StoragePhysicalDriveOperation" ], "default": "compute.StoragePhysicalDriveOperation", "x-enum-as-string": true }, "AdminAction": { "description": "Administrative actions that can be performed on the Storage Physical Drives.\n* `None` - No action on the selected Storage Physical Drives.\n* `SetJbod` - Set Jbod action state on the selected Storage Physical Drives.\n* `SetUnconfiguredGood` - Set Unconfigured Good action state on the selected Storage Physical Drives.\n* `Erase` - Set Erase action state on the selected Storage Controller.", "type": "string", "enum": [ "None", "SetJbod", "SetUnconfiguredGood", "Erase" ], "default": "None", "x-omitempty": true }, "ControllerId": { "description": "Storage Controller Id of the storage Physical Drives of the server.", "type": "string", "x-omitempty": true }, "DriveSlots": { "type": "array", "items": { "description": "Selected Storage Drives on the server.", "type": "string", "x-omitempty": true }, "nullable": true }, "PhysicalDrives": { "type": "array", "items": { "description": "Selected Storage Physical Drives on the server.", "$ref": "#/components/schemas/compute.StoragePhysicalDrive", "x-omitempty": true }, "nullable": true } } } ] }, "compute.StorageUtilityImageOperation": { "title": "Compute:Storage Utility Image Operation", "description": "The operation that can be performed on the FlexMMC images on the servers.", "x-allOf-name": "compute.StorageUtilityImageOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StorageUtilityImageOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StorageUtilityImageOperation" ], "default": "compute.StorageUtilityImageOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StorageUtilityImageOperation" ], "default": "compute.StorageUtilityImageOperation", "x-enum-as-string": true }, "Action": { "description": "Actions that can be performed by the storage utility.\n* `None` - No action by storage utility.\n* `Upload` - Upload action by storage utility.\n* `TurnOnImageVisibility` - Turn on image's visibility.\n* `TurnOffImageVisibility` - Turn off image's visibility.\n* `Remove` - Removes images from a server's utility storage.", "type": "string", "enum": [ "None", "Upload", "TurnOnImageVisibility", "TurnOffImageVisibility", "Remove" ], "default": "None", "x-omitempty": true }, "ImageName": { "description": "The image name this action operates on.", "type": "string", "x-omitempty": true }, "ImageType": { "description": "The image type this action operates on.", "type": "string", "x-omitempty": true } } } ] }, "compute.StorageVirtualDrive": { "title": "Compute:Storage Virtual Drive", "description": "Storage Virtual Drives on which an operation has to be performed.", "x-allOf-name": "compute.StorageVirtualDrive", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StorageVirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StorageVirtualDrive" ], "default": "compute.StorageVirtualDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StorageVirtualDrive" ], "default": "compute.StorageVirtualDrive", "x-enum-as-string": true }, "Id": { "description": "Virtual Drive ID of the storage on the server.", "type": "string", "x-omitempty": true } } } ] }, "compute.StorageVirtualDriveOperation": { "title": "Compute:Storage Virtual Drive Operation", "description": "The operation that can be performed on the Storage Virtual Drives on the servers.", "x-allOf-name": "compute.StorageVirtualDriveOperation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.StorageVirtualDriveOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.StorageVirtualDriveOperation" ], "default": "compute.StorageVirtualDriveOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.StorageVirtualDriveOperation" ], "default": "compute.StorageVirtualDriveOperation", "x-enum-as-string": true }, "AdminAction": { "description": "Administrative actions that can be performed on the Storage Virtual Drives.\n* `None` - No action on the selected Storage virtual Drives.\n* `Delete` - Delete action on the selected Storage Virtual Drives.", "type": "string", "enum": [ "None", "Delete" ], "default": "None", "x-omitempty": true }, "ControllerId": { "description": "Storage Controller Id of the storage Virtual Drives of the server.", "type": "string", "x-omitempty": true }, "VirtualDrives": { "type": "array", "items": { "description": "Selected Storage Virtual Drives on the server.", "$ref": "#/components/schemas/compute.StorageVirtualDrive", "x-omitempty": true }, "nullable": true } } } ] }, "compute.Vmedia.Response": { "description": "The response body of a HTTP GET request for the 'compute.Vmedia' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'compute.Vmedia' resources.", "x-one-of-name": "compute.Vmedia.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/compute.Vmedia.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "compute.Vmedia.Relationship": { "description": "A relationship to the 'compute.Vmedia' resource, or the expanded 'compute.Vmedia' resource, or the 'null' value.", "x-one-of-name": "compute.Vmedia.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/compute.Vmedia" } ], "discriminator": { "propertyName": "ClassId" } }, "compute.Vmedia": { "title": "Virtual Media Configuration", "description": "The compute.vMedia object represents the virtual media configuration and inventory for a server. It acts as a container for virtual media settings and any currently mapped virtual media images.\n#### Purpose\nThe vMedia object is used to manage and monitor the virtual media service on a server. This provides a central point to ensure that the service is enabled, if encryption is active, and what virtual media images are currently mapped. It is essential for remote OS installation, diagnostics, and maintenance.\n#### Key Concepts\n- **Service Configuration:** Provides key settings for the virtual media service, including whether it is enabled and if encryption is active for communications.\n- **Image Inventory:** Contains a collection of compute.Mapping objects, each representing a specific virtual media image that has been mounted to the server.\n- **Boot Integration:** The lowPowerUsb setting controls whether virtual drives appear in the host's boot selection menu, integrating virtual media directly into the boot process.\n- **Centralized Management:** Aggregates all virtual media information for a server into a single, manageable object.", "x-allOf-name": "compute.Vmedia", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'compute.Vmedia', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "compute.Vmedia" ], "default": "compute.Vmedia", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "compute.Vmedia" ], "default": "compute.Vmedia", "x-enum-as-string": true }, "Enabled": { "description": "State of the Virtual Media service on the server.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Encryption": { "description": "If enabled, allows encryption of all Virtual Media communications.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LowPowerUsb": { "description": "If enabled, the virtual drives appear on the boot selection menu after mapping the image and rebooting the host.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "ComputePhysicalUnit": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Mappings": { "description": "An array of relationships to computeMapping resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Mapping.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "compute.Vmedia.List": { "title": "List of 'compute.Vmedia' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'compute.Vmedia' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'compute.Vmedia' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Vmedia" }, "nullable": true } } } ] }, "deviceconnector.Policy.Response": { "description": "The response body of a HTTP GET request for the 'deviceconnector.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'deviceconnector.Policy' resources.", "x-one-of-name": "deviceconnector.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/deviceconnector.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "deviceconnector.Policy": { "title": "Device Connector", "description": "The Device Connector Policy is a reusable policy that controls whether configuration changes are permitted directly on a server's local management interface (Cisco IMC) when it is being managed by Intersight.\n#### Purpose\nThe purpose of this policy is to enforce a single source of truth for server configuration. When a server is managed by Intersight, this policy can be used to \"lock\" the configuration on the endpoint, preventing out-of-band changes that could cause configuration drift and conflicts with the settings defined in the Intersight server profile.\n#### Key Concepts\n- **Configuration Lockout:** Its primary feature is the lockoutEnabled flag, which, when set to true, prevents administrators from making configuration changes through the local Cisco IMC interface.\n- **Standalone Server Management:** This policy is specifically designed for servers operating in Standalone Mode (not connected to Fabric Interconnect, i.e. not in IMM mode).\n- **Profile-Based Enforcement:** It is applied to servers by including it in a Server Profile.\n- **Impact Awareness:** Applying this policy can cause a brief management network disconnection, which is flagged by the MgmtNetworkDisconnection disruption type.", "x-allOf-name": "deviceconnector.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'deviceconnector.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "deviceconnector.Policy" ], "default": "deviceconnector.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "deviceconnector.Policy" ], "default": "deviceconnector.Policy", "x-enum-as-string": true }, "LockoutEnabled": { "description": "Enables configuration lockout on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "deviceconnector.Policy.List": { "title": "List of 'deviceconnector.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'deviceconnector.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'deviceconnector.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/deviceconnector.Policy" }, "nullable": true } } } ] }, "equipment.AbstractDevice": { "title": "Equipment:Abstract Device", "description": "Common attributes for inventory device in Intersight.", "x-allOf-name": "equipment.AbstractDevice", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.AbstractDevice', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "meraki.Device", "storage.HitachiArray", "storage.NetAppCluster", "storage.PureArray", "storage.PureFlashBladeSystem" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "meraki.Device", "storage.HitachiArray", "storage.NetAppCluster", "storage.PureArray", "storage.PureFlashBladeSystem" ], "x-enum-as-string": true }, "DeviceLocation": { "description": "The location of the device.", "$ref": "#/components/schemas/equipment.DeviceLocation", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "The categorization of the device type. Optional parameter to categorize devices by product type. For example, Meraki device types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and secureConnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "HardwareVersion": { "description": "The hardware version of the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Administrator defined name for the device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Unique identity of the device.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Current running software version of the device.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.Base.Relationship": { "description": "A relationship to the 'equipment.Base' resource, or the expanded 'equipment.Base' resource, or the 'null' value.", "x-one-of-name": "equipment.Base.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Base" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Base": { "title": "Equipment:Base", "description": "Abstract base class for all equipments which have a vendor /model / serial.", "x-allOf-name": "equipment.Base", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Base', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.BootDevice", "bios.SystemBootOrder", "bios.Unit", "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "compute.Blade", "compute.Board", "compute.RackUnit", "equipment.Chassis", "equipment.ChassisController", "equipment.EnclosureElement", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoExpander", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "graphics.Card", "graphics.Controller", "memory.Array", "memory.PersistentMemoryUnit", "memory.Unit", "meraki.Device", "network.Element", "network.SecureRouter", "network.SupervisorCard", "pci.CoprocessorCard", "pci.Device", "pci.Link", "pci.Node", "pci.Slot", "pci.Switch", "processor.Unit", "security.Unit", "storage.BatteryBackupUnit", "storage.Controller", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilPhysicalDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.PureFlashBladeSystem", "storage.SasExpander", "storage.VirtualDrive", "storage.VirtualDriveContainer" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.BootDevice", "bios.SystemBootOrder", "bios.Unit", "boot.CddDevice", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "compute.Blade", "compute.Board", "compute.RackUnit", "equipment.Chassis", "equipment.ChassisController", "equipment.EnclosureElement", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoExpander", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "graphics.Card", "graphics.Controller", "memory.Array", "memory.PersistentMemoryUnit", "memory.Unit", "meraki.Device", "network.Element", "network.SecureRouter", "network.SupervisorCard", "pci.CoprocessorCard", "pci.Device", "pci.Link", "pci.Node", "pci.Slot", "pci.Switch", "processor.Unit", "security.Unit", "storage.BatteryBackupUnit", "storage.Controller", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilPhysicalDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.PureFlashBladeSystem", "storage.SasExpander", "storage.VirtualDrive", "storage.VirtualDriveContainer" ], "x-enum-as-string": true }, "IsUpgraded": { "description": "This field indicates the compute status of the catalog values for the associated component or hardware.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field displays the model number of the associated component or hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "Presence": { "description": "This field indicates the presence (equipped) or absence (absent) of the associated component or hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "Revision": { "description": "This field displays the revised version of the associated component or hardware (if any).", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "This field displays the serial number of the associated component or hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "This field displays the vendor information of the associated component or hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreviousFru": { "$ref": "#/components/schemas/equipment.Fru.Relationship", "description": "A reference to a equipmentFru resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.BaseSensor": { "title": "Equipment:Base Sensor", "description": "Information for a particular sensor on a storage array controller.", "x-allOf-name": "equipment.BaseSensor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.BaseSensor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppSensor" ], "default": "storage.NetAppSensor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppSensor" ], "default": "storage.NetAppSensor", "x-enum-as-string": true }, "ControllerName": { "description": "The name of the storage array controller that the sensor applies to.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of a specific sensor.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of the specified sensor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the specified sensor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Units": { "description": "The units that correspond to the value of the sensor, if applicable.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "The value of the specified sensor.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.Chassis.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Chassis' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Chassis' resources.", "x-one-of-name": "equipment.Chassis.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Chassis.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Chassis.Relationship": { "description": "A relationship to the 'equipment.Chassis' resource, or the expanded 'equipment.Chassis' resource, or the 'null' value.", "x-one-of-name": "equipment.Chassis.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Chassis" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Chassis": { "title": "Equipment:Chassis", "description": "The equipment.Chassis object represents a physical chassis, a modular enclosure that houses and provides power, cooling, and connectivity for multiple blade servers and I/O modules (IOMs).\n#### Purpose\nThe Chassis object serves as the primary inventory and management entity for a server chassis. It acts as a top-level container for all the components within it, including compute.Blade servers, equipment.IoCard modules, equipment.Psu power supply units, and equipment.FanModule fan modules. This provides a comprehensive, queryable view of the chassis's identity, health, and contained hardware.\n#### Key Concepts\n- **Centralized Enclosure Management:** Aggregates all components of a chassis into a single, manageable entity.\n- **Hierarchical Inventory:** Provides a structured parent-child relationship to all its contained components, such as blades, IOMs, PSUs, and fans.\n- **Health and Status Monitoring:** Reports on the overall operState of the chassis and provides a summary of alarms (alarmSummary) and fault conditions (faultSummary).\n- **Location and Identity:** Uniquely identified by a chassisId and serial number, and provides its name and user-assigned label for easy identification.", "x-allOf-name": "equipment.Chassis", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Chassis', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Chassis" ], "default": "equipment.Chassis", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Chassis" ], "default": "equipment.Chassis", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of alarm counts based on the severity types (Critical or Warning).", "$ref": "#/components/schemas/compute.AlarmSummary", "x-omitempty": true }, "ChassisId": { "description": "The assigned identifier for a chassis.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ChassisProfile": { "description": "The distinguished name of the chassis profile to which the chassis is associated to. It is applicable only for chassis which are managed via UCSM.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionPath": { "description": "This field identifies the connectivity path for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "This field identifies the connectivity status for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field is to provide description for chassis model.", "type": "string", "readOnly": true, "x-omitempty": true }, "FaultSummary": { "description": "This field summarizes the faults on the chassis enclosure.", "deprecated": true, "x-sunset": "2027-03-01", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "Location details associated with the managed object. When a Target object is assigned to a location the details of the associated location are copied into the Target and other related objects in the LocationDetails property.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "ManagementMode": { "description": "The management mode of the blade server chassis.\n* `IntersightStandalone` - Intersight Standalone mode of operation.\n* `UCSM` - Unified Computing System Manager mode of operation.\n* `Intersight` - Intersight managed mode of operation.", "type": "string", "enum": [ "IntersightStandalone", "UCSM", "Intersight" ], "default": "IntersightStandalone", "readOnly": true, "x-omitempty": true }, "Name": { "description": "This field identifies the name for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the FEX or IO Card.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field identifies the Chassis Operational State.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operations": { "type": "array", "items": { "description": "The status of completed and in-progress chassis operations.", "$ref": "#/components/schemas/equipment.ChassisOperationsDetails", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PackageVersion": { "description": "Bundle version which the XFM and PSU firmware belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part Number identifier for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "PlatformType": { "description": "The platform type that the chassis is a part of.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductName": { "description": "This field identifies the Product Name for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stock Keeping Unit for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserLabel": { "description": "The user defined label assigned to the chassis.", "type": "string", "pattern": "^[ !#$%&\\(\\)\\*\\+,\\-\\./:;\\?@\\[\\]_\\{\\|\\}~a-zA-Z0-9]*$", "minLength": 0, "maxLength": 64, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for the chassis enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssignedLocation": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.GeoLocation.Relationship", "description": "A reference to a assetGeoLocation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Blades": { "description": "An array of relationships to computeBlade resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Blade.Relationship" }, "nullable": true, "readOnly": true }, "ExpanderModules": { "description": "An array of relationships to equipmentExpanderModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship" }, "nullable": true, "readOnly": true }, "FanControl": { "$ref": "#/components/schemas/equipment.FanControl.Relationship", "description": "A reference to a equipmentFanControl resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Fanmodules": { "description": "An array of relationships to equipmentFanModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Ioms": { "description": "An array of relationships to equipmentIoCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoCard.Relationship" }, "nullable": true, "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ManagementInterface": { "$ref": "#/components/schemas/management.Interface.Relationship", "description": "A reference to a managementInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElements": { "description": "An array of relationships to networkElement resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship" }, "nullable": true, "readOnly": true }, "PciNodes": { "description": "An array of relationships to pciNode resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Node.Relationship" }, "nullable": true, "readOnly": true }, "PowerControlState": { "$ref": "#/components/schemas/power.ControlState.Relationship", "description": "A reference to a powerControlState resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PsuControl": { "$ref": "#/components/schemas/equipment.PsuControl.Relationship", "description": "A reference to a equipmentPsuControl resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Psus": { "description": "An array of relationships to equipmentPsu resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Psu.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Sasexpanders": { "description": "An array of relationships to storageSasExpander resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.SasExpander.Relationship" }, "nullable": true, "readOnly": true }, "SecureRouters": { "description": "An array of relationships to networkSecureRouter resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship" }, "nullable": true, "readOnly": true }, "Siocs": { "description": "An array of relationships to equipmentSystemIoController resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SystemIoController.Relationship" }, "nullable": true, "readOnly": true }, "StorageEnclosures": { "description": "An array of relationships to storageEnclosure resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Enclosure.Relationship" }, "nullable": true, "readOnly": true }, "VirtualDriveContainer": { "description": "An array of relationships to storageVirtualDriveContainer resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDriveContainer.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "equipment.Chassis.List": { "title": "List of 'equipment.Chassis' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Chassis' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Chassis' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Chassis" }, "nullable": true } } } ] }, "equipment.ChassisController.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ChassisController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ChassisController' resources.", "x-one-of-name": "equipment.ChassisController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ChassisController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ChassisController.Relationship": { "description": "A relationship to the 'equipment.ChassisController' resource, or the expanded 'equipment.ChassisController' resource, or the 'null' value.", "x-one-of-name": "equipment.ChassisController.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.ChassisController" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.ChassisController": { "title": "Equipment:Chassis Controller", "description": "Chassis Controller represents the controller embedded within a network element that manages a chassis.", "x-allOf-name": "equipment.ChassisController", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisController" ], "default": "equipment.ChassisController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisController" ], "default": "equipment.ChassisController", "x-enum-as-string": true }, "EquipmentType": { "description": "The type of chassis controller.\n* `Unknown` - Chassis Controller equipment type is unknown.\n* `ECMC` - Chassis Controller equipment type is ECMC.", "type": "string", "enum": [ "Unknown", "ECMC" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of chassis controller.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of chassis controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.ChassisController.List": { "title": "List of 'equipment.ChassisController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ChassisController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ChassisController' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ChassisController" }, "nullable": true } } } ] }, "equipment.ChassisIdPool.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ChassisIdPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ChassisIdPool' resources.", "x-one-of-name": "equipment.ChassisIdPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ChassisIdPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ChassisIdPool": { "title": "Equipment:Chassis Id Pool", "description": "ChassisIdPool object contains pool of chassisId's that can be allocated for newly discovered chassis.", "x-allOf-name": "equipment.ChassisIdPool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/sw.IdPoolBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisIdPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisIdPool" ], "default": "equipment.ChassisIdPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisIdPool" ], "default": "equipment.ChassisIdPool", "x-enum-as-string": true }, "PreferredIds": { "type": "array", "items": { "description": "Preferred Ids to be configured for connected devices like chassis, FEX. User specifies these Ids in the port policy and these Ids are copied here on the Domain profile deployment.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.ChassisIdPool.List": { "title": "List of 'equipment.ChassisIdPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ChassisIdPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ChassisIdPool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ChassisIdPool" }, "nullable": true } } } ] }, "equipment.ChassisIdentity.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ChassisIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ChassisIdentity' resources.", "x-one-of-name": "equipment.ChassisIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ChassisIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ChassisIdentity": { "title": "Chassis Identity", "description": "The ChassisIdentity object uniquely identifies a chassis and includes connectivity details for its IOMs. It enables lifecycle operations such as decommission, recommission, and rediscover, ensuring accurate tracking and control within the system.\n#### Purpose\nChassisIdentity serves as a central point for managing chassis attributes, including connectivity and identity data. It is essential for operations involving chassis recognition and interaction, facilitating seamless integration with connected devices and systems.\n#### Key Concepts\n- **Connectivity Information:** ChassisIdentity captures detailed connectivity data, enabling precise management of IOMs and ensuring robust operational control.\n- **Unique Identification:** It provides a unique identifier for each chassis based on vendor, model, and serial number, ensuring accurate traceability and management.\n- **Integration:** Facilitates integration with other system components by maintaining relationships with inventoried remote chassis and associated objects.\n- **Lifecycle Management:** Supports operations such as discovery and recommission, ensuring efficient lifecycle management of chassis within the system.", "x-allOf-name": "equipment.ChassisIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.Identity" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisIdentity" ], "default": "equipment.ChassisIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisIdentity" ], "default": "equipment.ChassisIdentity", "x-enum-as-string": true }, "IoCardIdentityList": { "type": "array", "items": { "description": "List of IoCard Identity Connectivity Information.", "$ref": "#/components/schemas/equipment.IoCardIdentity", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ResetToDefault": { "description": "Determines the default configuration deployment state for a chassis.\n* `NA` - Configuration deployment is not applicable for the chassis.\n* `Pending` - Configuration is not deployed to either A or B side IO card of the chassis.\n* `Applied` - Configuration is deployed to both A and B side IO cards of the chassis.\n* `PendingA` - Configuration deployment is pending in the A side IO card of the chassis.\n* `PendingB` - Configuration deployment is pending in the B side IO card of the chassis.", "type": "string", "enum": [ "NA", "Pending", "Applied", "PendingA", "PendingB" ], "default": "NA", "readOnly": true, "x-omitempty": true }, "Chassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.ChassisIdentity.List": { "title": "List of 'equipment.ChassisIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ChassisIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ChassisIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ChassisIdentity" }, "nullable": true } } } ] }, "equipment.ChassisOperation.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ChassisOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ChassisOperation' resources.", "x-one-of-name": "equipment.ChassisOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ChassisOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ChassisOperation": { "title": "Chassis Operation", "description": "Models the configurable properties of Chassis.", "x-allOf-name": "equipment.ChassisOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisOperation" ], "default": "equipment.ChassisOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisOperation" ], "default": "equipment.ChassisOperation", "x-enum-as-string": true }, "AdminLocatorLedAction": { "description": "User configured state of the locator LED for the Chassis.\n* `None` - No operation action for the Locator Led of an equipment.\n* `TurnOn` - Turn on the Locator Led of an equipment.\n* `TurnOff` - Turn off the Locator Led of an equipment.", "type": "string", "enum": [ "None", "TurnOn", "TurnOff" ], "default": "None", "x-omitempty": true }, "AdminPowerCycleExpanderModuleSlotId": { "description": "Slot id of the expander module slot within chassis that needs to be power cycled.", "type": "integer", "format": "int64", "x-omitempty": true }, "AdminPowerCycleSlotId": { "description": "Slot id of the chassis slot that needs to be power cycled.", "type": "integer", "format": "int64", "x-omitempty": true }, "AdminResetConfigSlotId": { "description": "Slot id of the chassis slot that needs to have its configuration reset.", "type": "integer", "format": "int64", "x-omitempty": true }, "ChassisOperationStatus": { "type": "array", "items": { "description": "The status of completed and in-progress chassis operations.", "$ref": "#/components/schemas/equipment.ChassisOperationStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ConfigState": { "description": "The configured state of these settings in the target chassis. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target chassis. Applying - This state denotes that the settings are being applied in the target chassis. Failed - This state denotes that the settings could not be applied in the target chassis.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Chassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "equipment.ChassisOperation.List": { "title": "List of 'equipment.ChassisOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ChassisOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ChassisOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ChassisOperation" }, "nullable": true } } } ] }, "equipment.ChassisOperationStatus": { "title": "Equipment:Chassis Operation Status", "description": "The status of completed and in-progress chassis operations performed on the chassis.", "x-allOf-name": "equipment.ChassisOperationStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisOperationStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisOperationStatus" ], "default": "equipment.ChassisOperationStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisOperationStatus" ], "default": "equipment.ChassisOperationStatus", "x-enum-as-string": true }, "ConfigState": { "description": "The configured state of the settings in the target chassis. The value is any one of Applied, Applying or Failed. Applied - The state denotes that the settings are applied successfully in the target chassis. Applying - The state denotes that the settings are being applied in the target chassis. Failed - The state denotes that the settings could not be applied in the target chassis.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ExpanderModuleSlotId": { "description": "The slot id of the expander module within the chassis on which the chassis operation is performed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "The slot id of the device within the chassis on which the chassis operation is performed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "WorkflowId": { "description": "The workflow Id of the chassis operations workflow.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type of the chassis operation workflow. This can be used to distinguish different chassis operations.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.ChassisOperationsDetails": { "title": "Equipment:Chassis Operations Details", "description": "The status of completed and in-progress chassis operations.", "x-allOf-name": "equipment.ChassisOperationsDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ChassisOperationsDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ChassisOperationsDetails" ], "default": "equipment.ChassisOperationsDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ChassisOperationsDetails" ], "default": "equipment.ChassisOperationsDetails", "x-enum-as-string": true }, "ConfigState": { "description": "The configured state of the settings in the target chassis. The value is any one of Applied, Applying or Failed. Applied - The state denotes that the settings are applied successfully in the target chassis. Applying - The state denotes that the settings are being applied in the target chassis. Failed - The state denotes that the settings could not be applied in the target chassis.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type of the chassis operation workflow. This can be used to distinguish different chassis operations.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.DeviceLocation": { "title": "Equipment:Device Location", "description": "The DeviceLocation object captures the physical location of a device, including geographical coordinates, address details, and related information. It is a crucial component for managing the physical assets within an infrastructure, ensuring precise tracking and location-based management.\n#### Purpose\nDeviceLocation serves as a repository for location-specific information, enabling organizations to manage their physical assets efficiently. It supports accurate inventory tracking, maintenance planning, and location-based analytics.\n#### Key Concepts\n- **Geographical Tracking:** Provides latitude and longitude details, allowing precise mapping and tracking of device locations.\n- **Address Management:** Includes comprehensive address information, facilitating easy identification and management of physical assets.\n- **Integration:** Enhances integration with asset management systems, supporting location-based resource allocation and maintenance scheduling.", "x-allOf-name": "equipment.DeviceLocation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.DeviceLocation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.DeviceLocation" ], "default": "equipment.DeviceLocation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.DeviceLocation" ], "default": "equipment.DeviceLocation", "x-enum-as-string": true }, "Address": { "description": "The information about the address.", "type": "string", "readOnly": true, "x-omitempty": true }, "Latitude": { "description": "Location latitude in decimal degrees format.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Longitude": { "description": "Location longitude in decimal degrees format.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.DeviceSummary.Response": { "description": "The response body of a HTTP GET request for the 'equipment.DeviceSummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.DeviceSummary' resources.", "x-one-of-name": "equipment.DeviceSummary.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.DeviceSummary.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.DeviceSummary": { "title": "Equipment:Device Summary", "description": "The equipment.DeviceSummary object provides a simplified, aggregated view of an inventory component, such as a server or chassis. It is designed to be a lightweight object for use in summary lists and high-level dashboards.\n#### Purpose\nThe main purpose of DeviceSummary is to offer a consolidated and easy-to-query representation of a piece of equipment. It abstracts away the complexity of different device types (e.g., compute.Blade vs. compute.RackUnit) and presents a consistent set of key identifiers like model, serial, and dn. This simplifies the development of user interfaces that display lists of mixed hardware.\n#### Key Concepts\n- **Aggregated View:** Combines the most common and essential properties of an inventory object into a single, flat structure.\n- **Unified Model:** Provides a consistent representation for different types of underlying hardware, simplifying data consumption.\n- **Performance-Oriented:** Designed to be lightweight and efficiently queried, making it suitable for high-level summary views.\n- **Source Traceability:** The sourceObjectType and parent relationships allow for drilling down from the summary view to the full, detailed inventory object.", "x-allOf-name": "equipment.DeviceSummary", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.DeviceSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.DeviceSummary" ], "default": "equipment.DeviceSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.DeviceSummary" ], "default": "equipment.DeviceSummary", "x-enum-as-string": true }, "Dn": { "description": "The distinguished name that unambiguously identifies an object in the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Model": { "description": "This field identifies the model of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "This field identifies the serial number of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "SourceObjectType": { "description": "The source object type of the given component.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentFex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryParent": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.DeviceSummary.List": { "title": "List of 'equipment.DeviceSummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.DeviceSummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.DeviceSummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.DeviceSummary" }, "nullable": true } } } ] }, "equipment.EnclosureElement.Response": { "description": "The response body of a HTTP GET request for the 'equipment.EnclosureElement' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.EnclosureElement' resources.", "x-one-of-name": "equipment.EnclosureElement.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.EnclosureElement.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.EnclosureElement.Relationship": { "description": "A relationship to the 'equipment.EnclosureElement' resource, or the expanded 'equipment.EnclosureElement' resource, or the 'null' value.", "x-one-of-name": "equipment.EnclosureElement.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.EnclosureElement" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.EnclosureElement": { "title": "Equipment:Enclosure Element", "description": "The equipment.EnclosureElement object represents a physical enclosure within a server or chassis that holds manageable sub-components, such as GPUs. It serves as a container for these specialized hardware units.\n#### Purpose\nThe primary function of this object is to model and inventory a sub-enclosure within a larger system. It is particularly useful for systems with modular components, like a GPU enclosure that can be added to a server. This provides a logical grouping for the components it contains and reports on its own health and identity.\n#### Key Concepts\n- **Modular Component Container:** Acts as a physical and logical container for a set of related hardware components, like graphics.Card objects.\n- **Health and Status Monitoring:** Reports its own operState and any specific health issues through the operReason property, such as temperature warnings.\n- **Unique Identification:** Identified by an enclosureId and other hardware details like pid, vid, and sku.\n- **Hierarchical Inventory:** Exists as a child of a compute.RackUnit, linking it directly to the server that houses it.", "x-allOf-name": "equipment.EnclosureElement", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.EnclosureElement', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.EnclosureElement" ], "default": "equipment.EnclosureElement", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.EnclosureElement" ], "default": "equipment.EnclosureElement", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description for the Enclosure module.", "type": "string", "readOnly": true, "x-omitempty": true }, "EnclosureId": { "description": "This field acts as the identifier for this particular Enclosure Module, within the Server or Fabric Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the pluggable Enclosure Module.", "type": "string", "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Enclosure module.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field is used to indicate this equipment enclosure's operational state.", "type": "string", "x-omitempty": true }, "PartNumber": { "description": "This field identifies the Part Number for this Enclosure Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the Enclosure module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stockkeeping Unit for this Enclosure Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "This field is to abstract the status of the Enclosure module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the Enclosure module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for this Enclosure Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FirmwareRunningFirmwares": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.EnclosureElement.List": { "title": "List of 'equipment.EnclosureElement' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.EnclosureElement' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.EnclosureElement' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.EnclosureElement" }, "nullable": true } } } ] }, "equipment.EndPointLog.Response": { "description": "The response body of a HTTP GET request for the 'equipment.EndPointLog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.EndPointLog' resources.", "x-one-of-name": "equipment.EndPointLog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.EndPointLog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.EndPointLog": { "title": "EndPoint Log", "description": "The EndPointLog object encapsulates log file information collected from Cisco endpoints. This provides insights into log collection and management processes.\n#### Purpose\nEndPointLog serves to document and manage log files collected from endpoints, supporting troubleshooting and operational insights. It aids in maintaining transparency and accountability in log management.\n#### Key Concepts\n- **Log Management:** Handles log file types and collection statuses, offering visibility into endpoint operations.\n- **Access Control:** Defines privilege sets for reading log information, ensuring secure and controlled access.\n- **Integration with Devices:** Links with registered devices and servers to ensure logs are associated correctly within the network.\n- **Relationship Management:** Facilitates connections with related objects, supporting cohesive log management.", "x-allOf-name": "equipment.EndPointLog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.EndPointLog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.EndPointLog" ], "default": "equipment.EndPointLog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.EndPointLog" ], "default": "equipment.EndPointLog", "x-enum-as-string": true }, "CollectionTime": { "description": "The time at which the log was collected.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DownloadUrl": { "description": "The Url to download the end point log.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileName": { "description": "The end point log file name.", "type": "string", "readOnly": true, "x-omitempty": true }, "LogType": { "description": "The end point log file type.\n* `None` - End point log file type None.\n* `SEL` - End point log file type SEL.", "type": "string", "enum": [ "None", "SEL" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The end point log collection status.\n* `None` - Log collection not started.\n* `CollectionInProgress` - Log file collection is in progress.\n* `CollectionCompleted` - Log file collection completed.\n* `CollectionFailed` - Log file collection failed.\n* `UploadInProgress` - Log file upload is in progress.\n* `UploadCompleted` - Log file upload completed.\n* `UploadFailed` - Log file upload failed to complete.\n* `DownloadUrlCreationFailed` - Download Url creation failed.\n* `Completed` - Log collection and upload completed.", "type": "string", "enum": [ "None", "CollectionInProgress", "CollectionCompleted", "CollectionFailed", "UploadInProgress", "UploadCompleted", "UploadFailed", "DownloadUrlCreationFailed", "Completed" ], "default": "None", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.EndPointLog.List": { "title": "List of 'equipment.EndPointLog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.EndPointLog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.EndPointLog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.EndPointLog" }, "nullable": true } } } ] }, "equipment.ExpanderModule.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ExpanderModule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ExpanderModule' resources.", "x-one-of-name": "equipment.ExpanderModule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ExpanderModule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ExpanderModule.Relationship": { "description": "A relationship to the 'equipment.ExpanderModule' resource, or the expanded 'equipment.ExpanderModule' resource, or the 'null' value.", "x-one-of-name": "equipment.ExpanderModule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.ExpanderModule" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.ExpanderModule": { "title": "Equipment:Expander Module", "description": "The equipment.ExpanderModule object represents a physical expander module installed within a chassis. These modules typically provide additional connectivity or resources for the components within the chassis.\n#### Purpose\nThe main purpose of this object is to inventory and monitor the state of an expander module. It captures the module's identity, its operational state, and any health-related issues. For example, it can house its own set of fan modules for cooling, which are represented as child objects.\n#### Key Concepts\n- **Hardware Inventory:** Provides a detailed record of the expander module, including its moduleId, partNumber, and operState.\n- **Health Monitoring:** The operReason collection provides specific details on any health issues affecting the module.\n- **Hierarchical Structure:** Acts as a container for its own sub-components, such as equipment.FanModule objects.\n- **Chassis Component:** It is a child of an equipment.Chassis object, clearly defining its location and role within the overall system.", "x-allOf-name": "equipment.ExpanderModule", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ExpanderModule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ExpanderModule" ], "default": "equipment.ExpanderModule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ExpanderModule" ], "default": "equipment.ExpanderModule", "x-enum-as-string": true }, "FirmwareVersion": { "description": "Firmware Version of the Chassis expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryReady": { "description": "The inventory ready field indicates whether the chassis expander module management controller has completed inventory of the installed devices.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ModuleId": { "description": "Module identifier for the expander module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of expander module.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part number identifier for the expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Side": { "description": "Location of the expander module within a chassis. The value can be top or bottom.\n* `unknown` - Physical location of the module is unknown.\n* `top` - Physical location of the module is on the top part of the chassis.\n* `bottom` - Physical location of the module is on the bottom part of the chassis.\n* `left` - Physical location of the module is on the left side of the chassis.\n* `right` - Physical location of the module is on the right side of the chassis.", "type": "string", "enum": [ "unknown", "top", "bottom", "left", "right" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FanModules": { "description": "An array of relationships to equipmentFanModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule.Relationship" }, "nullable": true, "readOnly": true }, "PciSwitches": { "description": "An array of relationships to pciSwitch resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Switch.Relationship" }, "nullable": true, "readOnly": true }, "PciZones": { "description": "An array of relationships to pciZone resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Zone.Relationship" }, "nullable": true, "readOnly": true }, "PhysicalDeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedAdapterUnits": { "description": "An array of relationships to equipmentSharedAdapterUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "equipment.ExpanderModule.List": { "title": "List of 'equipment.ExpanderModule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ExpanderModule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ExpanderModule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ExpanderModule" }, "nullable": true } } } ] }, "equipment.ExpanderModuleIdentity.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ExpanderModuleIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ExpanderModuleIdentity' resources.", "x-one-of-name": "equipment.ExpanderModuleIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ExpanderModuleIdentity": { "title": "Expander Module Identity Information", "description": "Identity object that uniquely represents a chassis XFM under a FI Device Registration.", "x-allOf-name": "equipment.ExpanderModuleIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.PhysicalIdentity" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ExpanderModuleIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ExpanderModuleIdentity" ], "default": "equipment.ExpanderModuleIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ExpanderModuleIdentity" ], "default": "equipment.ExpanderModuleIdentity", "x-enum-as-string": true }, "ChassisId": { "description": "Chassis Identifier of an expander module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Presence": { "description": "The presence state of the blade server.\n* `Unknown` - The default presence state.\n* `Equipped` - The server is equipped in the slot.\n* `EquippedMismatch` - The slot is equipped, but there is another server currently inventoried in the slot.\n* `Missing` - The server is not present in the given slot.", "type": "string", "enum": [ "Unknown", "Equipped", "EquippedMismatch", "Missing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "Chassis slot number of an expander module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.ExpanderModuleIdentity.List": { "title": "List of 'equipment.ExpanderModuleIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ExpanderModuleIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ExpanderModuleIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ExpanderModuleIdentity" }, "nullable": true } } } ] }, "equipment.ExpanderModuleOperation.Response": { "description": "The response body of a HTTP GET request for the 'equipment.ExpanderModuleOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.ExpanderModuleOperation' resources.", "x-one-of-name": "equipment.ExpanderModuleOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.ExpanderModuleOperation": { "title": "X-Fabric Module Operations", "description": "Contains the properties which can be used to perform chassis expander module operations (Ex- BMC reboot).", "x-allOf-name": "equipment.ExpanderModuleOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ExpanderModuleOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ExpanderModuleOperation" ], "default": "equipment.ExpanderModuleOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ExpanderModuleOperation" ], "default": "equipment.ExpanderModuleOperation", "x-enum-as-string": true }, "AdminOperation": { "description": "User configured operation on the X-Fabric Module.\n* `None` - Placeholder default value for iom power state property.\n* `Reboot` - IO Module reboot state property value.", "type": "string", "enum": [ "None", "Reboot" ], "default": "None", "x-omitempty": true }, "AffectedObjName": { "description": "Placeholder for affected object name which is a combination of chassis and X-Fabric Module ID. Used to display affected object in audit log.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "The configured state of these settings in the target X-Fabric Module. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target X-Fabric Module. Applying - This state denotes that the settings are being applied in the target X-Fabric Module. Failed - This state denotes that the settings could not be applied in the target X-Fabric Module.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "ExpanderModuleOperationStatus": { "type": "array", "items": { "description": "The status of completed and in-progress X-Fabric Module operations.", "$ref": "#/components/schemas/equipment.IoCardOperationStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Serial": { "description": "Serial ID of the X-Fabric Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.ExpanderModuleOperation.List": { "title": "List of 'equipment.ExpanderModuleOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.ExpanderModuleOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.ExpanderModuleOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.ExpanderModuleOperation" }, "nullable": true } } } ] }, "equipment.Fan.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Fan' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Fan' resources.", "x-one-of-name": "equipment.Fan.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Fan.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Fan.Relationship": { "description": "A relationship to the 'equipment.Fan' resource, or the expanded 'equipment.Fan' resource, or the 'null' value.", "x-one-of-name": "equipment.Fan.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Fan" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Fan": { "title": "Equipment:Fan", "description": "The equipment.Fan object represents an individual cooling fan within a larger piece of equipment, such as a fan module, chassis, or Fabric Extender (FEX).\n#### Purpose\nThe Fan object is designed to provide granular inventory and monitoring for a single fan. It captures the fan's identity (fanId), its operational state (operState), and any specific health issues (operReason). This level of detail is crucial for precise thermal management and fault detection within a system.\n#### Key Concepts\n- **Granular Component Monitoring:** Allows for the tracking of the status of each individual fan in a system.\n- **Health and State Reporting:** Provides the current operState (e.g., \"ok\", \"fail\") and detailed health reasons, such as speed or temperature threshold conditions.\n- **Unique Identification:** Identified by a fanId and moduleId, which specify its position within its parent fan module.\n- **Hierarchical Context:** Exists as a child of an equipment.FanModule or equipment.FEX, linking it to its physical housing and the larger system.", "x-allOf-name": "equipment.Fan", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Fan', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Fan" ], "default": "equipment.Fan", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Fan" ], "default": "equipment.Fan", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description for the fan.", "type": "string", "readOnly": true, "x-omitempty": true }, "FanId": { "description": "This field acts as the identifier for this particular Fan, within the Fabric Interconnect.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FanModuleId": { "description": "This field is used to identify the Fan Module to which this Fan belongs.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ModuleId": { "description": "Fan module Identifier for the fan.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the pluggable Fan.", "type": "string", "readOnly": true, "x-omitempty": true }, "NrThresholdMinRpmSpeed": { "description": "This field identifies the Non Recoverable Threshold Minimum Revolutions Per Minute Speed for this Fan Unit.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the fan.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field is used to indicate this fan unit's operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field identifies the Part Number for this Fan Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the fans.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stockkeeping Unit for this Fan Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "TrayId": { "description": "Tray identifier for the fan module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for this Fan Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "EquipmentFanModule": { "$ref": "#/components/schemas/equipment.FanModule.Relationship", "description": "A reference to a equipmentFanModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentFex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Fan.List": { "title": "List of 'equipment.Fan' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Fan' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Fan' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Fan" }, "nullable": true } } } ] }, "equipment.FanControl.Response": { "description": "The response body of a HTTP GET request for the 'equipment.FanControl' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.FanControl' resources.", "x-one-of-name": "equipment.FanControl.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.FanControl.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.FanControl.Relationship": { "description": "A relationship to the 'equipment.FanControl' resource, or the expanded 'equipment.FanControl' resource, or the 'null' value.", "x-one-of-name": "equipment.FanControl.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.FanControl" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.FanControl": { "title": "Equipment:Fan Control", "description": "This represents the states of Fan equipment.", "x-allOf-name": "equipment.FanControl", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.FanControl', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.FanControl" ], "default": "equipment.FanControl", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.FanControl" ], "default": "equipment.FanControl", "x-enum-as-string": true }, "Mode": { "description": "This field identifies the Fan Control Mode on the endpoint.\n* `Balanced` - Value of Fan Speed is Balanced.\n* `LowPower` - Value of Fan Speed is LowPower.\n* `HighPower` - Value of Fan Speed is HighPower.\n* `MaximumPower` - Value of Fan Speed is MaximumPower.\n* `MaximumCooling` - Value of Fan Speed is MaximumCooling.\n* `Acoustic` - Value of Fan Speed is Acoustic.", "type": "string", "enum": [ "Balanced", "LowPower", "HighPower", "MaximumPower", "MaximumCooling", "Acoustic" ], "default": "Balanced", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.FanControl.List": { "title": "List of 'equipment.FanControl' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.FanControl' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.FanControl' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanControl" }, "nullable": true } } } ] }, "equipment.FanModule.Response": { "description": "The response body of a HTTP GET request for the 'equipment.FanModule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.FanModule' resources.", "x-one-of-name": "equipment.FanModule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.FanModule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.FanModule.Relationship": { "description": "A relationship to the 'equipment.FanModule' resource, or the expanded 'equipment.FanModule' resource, or the 'null' value.", "x-one-of-name": "equipment.FanModule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.FanModule" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.FanModule": { "title": "Equipment:Fan Module", "description": "The equipment.FanModule object represents a physical, often hot-swappable, module that houses one or more individual fans. These modules are key components for cooling in chassis, servers, and network switches.\n#### Purpose\nThe FanModule object serves as a container and management point for a group of fans. This provides inventory details for the module itself (model, serial, etc.) and reports on its overall operational state. It also acts as the parent for the individual equipment.Fan objects it contains.\n#### Key Concepts\n- **Component Aggregation:** Groups multiple individual fans into a single, field-replaceable unit (FRU).\n- **Hierarchical Inventory:** Acts as a parent container for a collection of equipment.Fan objects, providing a structured view of the cooling system.\n- **Health and Status Monitoring:** Reports its own operState and provides a summary of its health through the operReason property.\n- **Location Identification:** Identified by a moduleId and trayId, which specify its physical location within the parent equipment (e.g., a chassis or an I/O module).", "x-allOf-name": "equipment.FanModule", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.FanModule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.FanModule" ], "default": "equipment.FanModule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.FanModule" ], "default": "equipment.FanModule", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description for the fan module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModuleId": { "description": "This field acts as the identifier for this particular Module, within the Fabric Interconnect.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the pluggable FanModule.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the fan module.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field is used to indicate this fan module's operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field identifies the Part Number for this Fan Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the fan module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stockkeeping Unit for this Fan Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "This field is to abstract the status of the fan module.", "type": "string", "readOnly": true, "x-omitempty": true }, "TrayId": { "description": "Tray identifier for the fan module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for this Fan Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentIoCard": { "$ref": "#/components/schemas/equipment.IoCard.Relationship", "description": "A reference to a equipmentIoCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EquipmentRackEnclosure": { "$ref": "#/components/schemas/equipment.RackEnclosure.Relationship", "description": "A reference to a equipmentRackEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Fans": { "description": "An array of relationships to equipmentFan resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Fan.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.FanModule.List": { "title": "List of 'equipment.FanModule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.FanModule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.FanModule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule" }, "nullable": true } } } ] }, "equipment.Fex.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Fex' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Fex' resources.", "x-one-of-name": "equipment.Fex.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Fex.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Fex.Relationship": { "description": "A relationship to the 'equipment.Fex' resource, or the expanded 'equipment.Fex' resource, or the 'null' value.", "x-one-of-name": "equipment.Fex.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Fex" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Fex": { "title": "Equipment:Fex", "description": "The equipment.FEX object represents a Fabric Extender (FEX), a device that acts as a remote line card for a parent Fabric Interconnect. It multiplexes traffic from servers and other endpoints to the main switch.\n#### Purpose\nThe FEX object is the primary inventory and management entity for a Fabric Extender. This provides a comprehensive view of the FEX's identity, its connection status to the parent switch, and its contained hardware components, such as power supplies, fans, and host-facing ports.\n#### Key Concepts\n- **Remote Line Card Model:** Represents the FEX as an extension of a parent network.Element (Fabric Interconnect).\n- **Hierarchical Inventory:** Serves as a container for its own hardware components, including equipment.Psu, equipment.Fan, and ether.HostPort objects.\n- **Connectivity and Health:** Tracks its connectionPath and connectionStatus to the parent switch, and reports its overall operState and any specific health issues (operReason).\n- **Lifecycle Management:** The discoveryState property tracks its progress through the discovery and inventory process.", "x-allOf-name": "equipment.Fex", "allOf": [ { "$ref": "#/components/schemas/equipment.IoCardBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Fex', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Fex" ], "default": "equipment.Fex", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Fex" ], "default": "equipment.Fex", "x-enum-as-string": true }, "ConnectionPath": { "description": "Switch Id to which the FEX is connected to. The value can be A or B or AB in case of active-active topology.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiscoveryState": { "description": "Discovery state of IO card or fabric extender.", "type": "string", "x-omitempty": true }, "Fans": { "description": "An array of relationships to equipmentFan resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Fan.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Ioms": { "description": "An array of relationships to equipmentIoCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoCard.Relationship" }, "nullable": true, "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Psus": { "description": "An array of relationships to equipmentPsu resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Psu.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Fex.List": { "title": "List of 'equipment.Fex' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Fex' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Fex' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Fex" }, "nullable": true } } } ] }, "equipment.FexIdentity.Response": { "description": "The response body of a HTTP GET request for the 'equipment.FexIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.FexIdentity' resources.", "x-one-of-name": "equipment.FexIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.FexIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.FexIdentity": { "title": "Equipment:Fex Identity", "description": "The FexIdentity object encapsulates the identity and connectivity context of a Fabric Extender (FEX) in the management system. It unifies vendor, model, serial, and switch-connection details to support consistent inventory, policy deployment, and lifecycle operations for fabric extenders.\n#### Purpose \nA FexIdentity provides the authoritative record of a FEX's identity and its association within a fabric interconnect domain. It enables accurate inventory and health monitoring of fabric extenders, supports targeted configuration and firmware upgrades for specific FEX units, and maintains relationship mapping to the parent network element and device registration.\n#### Key Concepts \n- **Connectivity Context:** Records the switch port and network element reference where the FEX is attached. \n- **Unique Identity:** Uses vendor/model/serial plus registration to ensure a one-to-one mapping. \n- **Permission Inheritance:** Adopts access controls from the registered device to govern update privileges. \n- **Lifecycle Events:** Coordinates FEX discovery, removal, and firmware operations within orchestration workflows.", "x-allOf-name": "equipment.FexIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.PhysicalIdentity" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.FexIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.FexIdentity" ], "default": "equipment.FexIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.FexIdentity" ], "default": "equipment.FexIdentity", "x-enum-as-string": true }, "SwitchId": { "description": "Switch ID to which Fabric Extender is connected, ID can be either 1 or 2, equalent to A or B.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Fex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "equipment.FexIdentity.List": { "title": "List of 'equipment.FexIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.FexIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.FexIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FexIdentity" }, "nullable": true } } } ] }, "equipment.FexOperation.Response": { "description": "The response body of a HTTP GET request for the 'equipment.FexOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.FexOperation' resources.", "x-one-of-name": "equipment.FexOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.FexOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.FexOperation": { "title": "Fabric Extender Operations", "description": "Models the configuration states of a FEX in Intersight.", "x-allOf-name": "equipment.FexOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.FexOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.FexOperation" ], "default": "equipment.FexOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.FexOperation" ], "default": "equipment.FexOperation", "x-enum-as-string": true }, "AdminLocatorLedAction": { "description": "Action performed on the locator LED for a FEX.\n* `None` - No operation action for the Locator Led of an equipment.\n* `TurnOn` - Turn on the Locator Led of an equipment.\n* `TurnOff` - Turn off the Locator Led of an equipment.", "type": "string", "enum": [ "None", "TurnOn", "TurnOff" ], "default": "None", "x-omitempty": true }, "AdminLocatorLedActionState": { "description": "Defines status of action performed on AdminLocatorLedState.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Fex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.FexOperation.List": { "title": "List of 'equipment.FexOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.FexOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.FexOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FexOperation" }, "nullable": true } } } ] }, "equipment.Fru.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Fru' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Fru' resources.", "x-one-of-name": "equipment.Fru.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Fru.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Fru.Relationship": { "description": "A relationship to the 'equipment.Fru' resource, or the expanded 'equipment.Fru' resource, or the 'null' value.", "x-one-of-name": "equipment.Fru.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Fru" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Fru": { "title": "Equipment:Fru", "description": "The equipment.Fru object represents a Field-Replaceable Unit (FRU). It is a special object used to track the history and state changes of hardware components that have been inserted, removed, or replaced.\n#### Purpose\nThe primary purpose of the Fru object is to provide an audit trail for hardware maintenance actions. When a component is replaced, the previousFru relationship on the new component's inventory object will point to a Fru object that contains the vendor, model, and serial number of the old part. It is essential for asset tracking and troubleshooting issues related to hardware changes.\n#### Key Concepts\n- **Hardware Change Tracking:** Records the identity of a component that has been physically replaced or removed.\n- **Action Logging:** The action property specifies what happened to the FRU, with states like Inserted, Removed, or ReplacedWithAlarm.\n- **Historical Data:** Preserves the identity information of the old component, which would otherwise be lost after a replacement.\n- **Alarm Integration:** The ReplacedWithAlarm action is used to trigger alarms when a hardware replacement is detected, prompting administrative review and action.", "x-allOf-name": "equipment.Fru", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Fru', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Fru" ], "default": "equipment.Fru", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Fru" ], "default": "equipment.Fru", "x-enum-as-string": true }, "Action": { "description": "This field identifies the action performed on a component.\n* `None` - No action performed on the FRU.\n* `Inserted` - A new FRU is inserted or added.\n* `Removed` - The previous FRU is removed.\n* `Replaced` - The previous FRU is replaced with a new FRU.\n* `ReplacedWithAlarm` - The previous FRU is replaced with a new FRU and a alarm is raised.", "type": "string", "enum": [ "None", "Inserted", "Removed", "Replaced", "ReplacedWithAlarm" ], "default": "None", "x-omitempty": true }, "CurrentFru": { "$ref": "#/components/schemas/equipment.Base.Relationship", "description": "A reference to a equipmentBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Fru.List": { "title": "List of 'equipment.Fru' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Fru' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Fru' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Fru" }, "nullable": true } } } ] }, "equipment.HybridDriveSlot.Response": { "description": "The response body of a HTTP GET request for the 'equipment.HybridDriveSlot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.HybridDriveSlot' resources.", "x-one-of-name": "equipment.HybridDriveSlot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.HybridDriveSlot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.HybridDriveSlot.Relationship": { "description": "A relationship to the 'equipment.HybridDriveSlot' resource, or the expanded 'equipment.HybridDriveSlot' resource, or the 'null' value.", "x-one-of-name": "equipment.HybridDriveSlot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.HybridDriveSlot" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.HybridDriveSlot": { "title": "Equipment:Hybrid Drive Slot", "description": "The equipment.HybridDriveSlot object represents a specialized drive slot in a server that can operate in different modes, typically supporting NVMe or other drive types.\n#### Purpose\nThe main function of this object is to inventory and report on the configuration of a hybrid drive slot. It captures both the requestedMode (the desired configuration from a policy) and the currentMode (the actual operational mode). This allows administrators to manage and verify the configuration of these flexible drive bays.\n#### Key Concepts\n- **Flexible Drive Bay Model:** Represents a server slot that supports multiple operational modes for the installed drive (e.g., \"Controller\" or \"Direct\" mode).\n- **Configuration State Tracking:** Provides both the desired (requestedMode) and actual (currentMode) states, which is crucial for configuration management and verification.\n- **Slot Identification:** Uniquely identified by its slotId within the server.\n- **Server Component:** It is a child of a compute.Blade or compute.RackUnit, linking it directly to the server it belongs to.", "x-allOf-name": "equipment.HybridDriveSlot", "allOf": [ { "$ref": "#/components/schemas/equipment.Slot" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.HybridDriveSlot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.HybridDriveSlot" ], "default": "equipment.HybridDriveSlot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.HybridDriveSlot" ], "default": "equipment.HybridDriveSlot", "x-enum-as-string": true }, "CurrentMode": { "description": "The Configured Mode of the Hybrid Drive slot.\n* `` - Hybrid Drive slot mode is not applicable.\n* `Controller` - Hybrid Drive slot mode is Controller.\n* `Direct` - Hybrid Drive slot mode is Direct.", "type": "string", "enum": [ "", "Controller", "Direct" ], "default": "", "readOnly": true, "x-omitempty": true }, "RequestedMode": { "description": "The Requested Mode for the Hybrid Drive slot.\n* `` - Hybrid Drive slot mode is not applicable.\n* `Controller` - Hybrid Drive slot mode is Controller.\n* `Direct` - Hybrid Drive slot mode is Direct.", "type": "string", "enum": [ "", "Controller", "Direct" ], "default": "", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.HybridDriveSlot.List": { "title": "List of 'equipment.HybridDriveSlot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.HybridDriveSlot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.HybridDriveSlot' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.HybridDriveSlot" }, "nullable": true } } } ] }, "equipment.Identity": { "title": "Equipment:Identity", "description": "An abstract object for performing and tracking lifecycle operations (e.g. discovery, recommission, decommission) on rack-mount equipment such as server, chassis (consisting on IO Modules) and FEX.", "x-allOf-name": "equipment.Identity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Identity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ChassisIdentity", "equipment.ExpanderModuleIdentity", "equipment.FexIdentity", "fabric.ElementIdentity" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ChassisIdentity", "equipment.ExpanderModuleIdentity", "equipment.FexIdentity", "fabric.ElementIdentity" ], "x-enum-as-string": true }, "AdminAction": { "description": "Updated by UI/API to trigger specific action type.\n* `None` - No operation value for maintenance actions on an equipment.\n* `Decommission` - Decommission the equipment and temporarily remove it from being managed by Intersight.\n* `Recommission` - Recommission the equipment.\n* `Reack` - Reacknowledge the equipment and discover it again.\n* `Remove` - Remove the equipment permanently from Intersight management.\n* `Replace` - Replace the equipment with the other one.\n* `DecommissionAndRemove` - Decommissions the equipment and upon equipment physical removal, removes it automatically from Intersight.", "type": "string", "enum": [ "None", "Decommission", "Recommission", "Reack", "Remove", "Replace", "DecommissionAndRemove" ], "default": "None", "x-omitempty": true }, "AdminActionState": { "description": "The state of Maintenance Action performed. This will have three states. Applying - Action is in progress. Applied - Action is completed and applied. Failed - Action has failed.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Identifier": { "description": "Numeric Identifier assigned by the management system to the equipment. Identifier can only be changed if it has been PATCHED with the AdminAction property set to 'Recommission'.", "type": "integer", "format": "int64", "minimum": 1, "x-omitempty": true }, "Lifecycle": { "description": "The equipment's lifecycle status.\n* `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment.\n* `Active` - Default Lifecycle State for a physical entity.\n* `Decommissioned` - Decommission Lifecycle state.\n* `DecommissionInProgress` - Decommission Inprogress Lifecycle state.\n* `RecommissionInProgress` - Recommission Inprogress Lifecycle state.\n* `OperationFailed` - Failed Operation Lifecycle state.\n* `ReackInProgress` - ReackInProgress Lifecycle state.\n* `RemoveInProgress` - RemoveInProgress Lifecycle state.\n* `Discovered` - Discovered Lifecycle state.\n* `SlotReserved` - Blade is inserted in a slot that is reserved for Secure Router.\n* `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state.\n* `DiscoveryFailed` - DiscoveryFailed Lifecycle state.\n* `FirmwareUpgradeInProgress` - Firmware upgrade is in progress on given physical entity.\n* `DiagnosticsInProgress` - Diagnostics is in progress on given physical entity.\n* `SecureEraseInProgress` - Secure Erase is in progress on given physical entity.\n* `ScrubInProgress` - Scrub is in progress on given physical entity.\n* `BladeMigrationInProgress` - Server slot migration is in progress on given physical entity.\n* `Inactive` - Inactive Lifecycle state.\n* `ReplaceInProgress` - ReplaceInProgress Lifecycle state.\n* `SlotMismatch` - The blade server is detected in a different chassis/slot than it was previously.\n* `ReplacementPendingUserAction` - A new blade server is detected, and discovery is pending cleanup of old blade originally discovered in the new blade's location.\n* `Removed` - The blade server has been removed from its discovered slot, and not detected anywhere else within the domain.\n* `Moved` - The blade server has been moved from its discovered location to a new location within the domain.\n* `Replaced` - The blade server has been removed from its discovered location and another blade has been inserted. in that location.\n* `MovedAndReplaced` - The blade server has been moved from its discovered location to a new location within the domain and another blade has been inserted into the previously discovered location.\n* `DomainRmaPendingUserAction` - Domain RMA detected due to the presence of an old pair of FIs with mismatched serial numbers within the same account. User to either initiate the 'Replace Domain workflow' or unclaim the old domain.\n* `IdentityUnknown` - The endpoint cannot be identified because of incomplete vendor, model, or serial information.\n* `RestoreConfigInProgress` - Restore configuration is in progress on given physical entity.\n* `DecommissionAndRemoveInProgress` - Decommission and remove operation is in progress.\n* `DecommissionedForRemove` - Server is decommissioned and once it is physically pulled from chassis, it will be automatically removed from Inventory.", "type": "string", "enum": [ "None", "Active", "Decommissioned", "DecommissionInProgress", "RecommissionInProgress", "OperationFailed", "ReackInProgress", "RemoveInProgress", "Discovered", "SlotReserved", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "DiagnosticsInProgress", "SecureEraseInProgress", "ScrubInProgress", "BladeMigrationInProgress", "Inactive", "ReplaceInProgress", "SlotMismatch", "ReplacementPendingUserAction", "Removed", "Moved", "Replaced", "MovedAndReplaced", "DomainRmaPendingUserAction", "IdentityUnknown", "RestoreConfigInProgress", "DecommissionAndRemoveInProgress", "DecommissionedForRemove" ], "default": "None", "readOnly": true, "x-omitempty": true }, "LifecycleModTime": { "description": "The time when the last life cycle state change happened.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Model": { "description": "The vendor provided model name for the equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the equipment for unique identification.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "The serial number of the equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "The manufacturer of the equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "CustomPermissionResources": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Interconnect.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Interconnect' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Interconnect' resources.", "x-one-of-name": "equipment.Interconnect.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Interconnect.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Interconnect.Relationship": { "description": "A relationship to the 'equipment.Interconnect' resource, or the expanded 'equipment.Interconnect' resource, or the 'null' value.", "x-one-of-name": "equipment.Interconnect.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Interconnect" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Interconnect": { "title": "Equipment:Interconnect", "description": "Object representing a set of endpoints that are interconnected via some interconnectivity technology.", "x-allOf-name": "equipment.Interconnect", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Interconnect', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Interconnect" ], "default": "equipment.Interconnect", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Interconnect" ], "default": "equipment.Interconnect", "x-enum-as-string": true }, "InterconnectId": { "description": "The identifier of the interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterconnectType": { "description": "Type of interconnectivity provided by this interconnect.\n* `Unknown` - Interconnect type is unknown.\n* `NVLink` - Interconnect type is NVLink.", "type": "string", "enum": [ "Unknown", "NVLink" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InterconnectedGraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true, "readOnly": true }, "InterconnectedSharedGraphicsCards": { "description": "An array of relationships to equipmentSharedGraphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.Relationship" }, "nullable": true, "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Interconnect.List": { "title": "List of 'equipment.Interconnect' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Interconnect' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Interconnect' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Interconnect" }, "nullable": true } } } ] }, "equipment.IoCard.Response": { "description": "The response body of a HTTP GET request for the 'equipment.IoCard' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.IoCard' resources.", "x-one-of-name": "equipment.IoCard.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.IoCard.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.IoCard.Relationship": { "description": "A relationship to the 'equipment.IoCard' resource, or the expanded 'equipment.IoCard' resource, or the 'null' value.", "x-one-of-name": "equipment.IoCard.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.IoCard" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.IoCard": { "title": "Equipment:Io Card", "description": "The equipment.IoCard (IOM) object represents an I/O Module, a critical component in a blade chassis that multiplexes and forwards network traffic between the blade servers and the upstream Fabric Interconnects.\n#### Purpose\nThe IoCard object is the primary inventory and management entity for an IOM. This provides a comprehensive view of the module's identity, operational state, health, and its connection path to the parent Fabric Interconnect. It also serves as a container for its own sub-components, such as fan modules.\n#### Key Concepts\n- **Chassis Network Hub:** Models the central networking component within a chassis that connects servers to the fabric.\n- **Connectivity and Pathing:** The connectionPath property (e.g., \"A\" or \"B\") and its relationship to a network.Element define its role and connection to the fabric.\n- **Health Monitoring:** Reports its overall operState and specific health issues (operReason), such as temperature warnings or low memory conditions.\n- **Hierarchical Inventory:** Acts as a parent container for its own components, like equipment.FanModule, and for the host-facing ports that connect to the servers.", "x-allOf-name": "equipment.IoCard", "allOf": [ { "$ref": "#/components/schemas/equipment.IoCardBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoCard', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.IoCard" ], "default": "equipment.IoCard", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.IoCard" ], "default": "equipment.IoCard", "x-enum-as-string": true }, "ConnectionPath": { "description": "Switch Id to which the IOM is connected to. The value can be A or B.", "type": "string", "readOnly": true, "x-omitempty": true }, "DcSupported": { "description": "IOM device connector support.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "InbandIpAddresses": { "type": "array", "items": { "description": "The list of Inband Ip addresses for the CMC.", "$ref": "#/components/schemas/compute.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OutOfBandIpAddresses": { "type": "array", "items": { "description": "The list of Outband Ip addresses for the CMC.", "$ref": "#/components/schemas/compute.IpAddress", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Side": { "description": "Location of IOM within a chassis. The value can be left or right.", "type": "string", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentFex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FanModules": { "description": "An array of relationships to equipmentFanModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule.Relationship" }, "nullable": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.IoCard.List": { "title": "List of 'equipment.IoCard' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.IoCard' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.IoCard' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoCard" }, "nullable": true } } } ] }, "equipment.IoCardBase.Relationship": { "description": "A relationship to the 'equipment.IoCardBase' resource, or the expanded 'equipment.IoCardBase' resource, or the 'null' value.", "x-one-of-name": "equipment.IoCardBase.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.IoCardBase" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.IoCardBase": { "title": "Equipment:Io Card Base", "description": "Abstract class for hif and nif ports collection that can be extended by chassis/febric extender.", "x-allOf-name": "equipment.IoCardBase", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoCardBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "equipment.Fex", "equipment.IoCard" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "equipment.Fex", "equipment.IoCard" ], "x-enum-as-string": true }, "ConnectionStatus": { "description": "Connectivity Status of FEX/IOM to Switch - A or B or AB.", "type": "string", "x-omitempty": true }, "Description": { "description": "This field is to provide description for the iocard module model.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModuleId": { "description": "Module Identifier for the IO module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the FEX or IO Card.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of IO card or fabric extender.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part Number identifier for the IO module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the IO module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductName": { "description": "This field identifies the Product Name for the iocard module model.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stock Keeping Unit for the IO card module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "This field identifies the version of the IO card module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for the IO card module.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostPorts": { "description": "An array of relationships to etherHostPort resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.HostPort.Relationship" }, "nullable": true }, "MgmtController": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkPorts": { "description": "An array of relationships to etherNetworkPort resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.NetworkPort.Relationship" }, "nullable": true }, "SubGroup": { "description": "An array of relationships to portSubGroup resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/port.SubGroup.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "equipment.IoCardIdentity": { "title": "Equipment:Io Card Identity", "description": "IoCardIdentity Complex type referenced in ChassisIdentity concrete MO.", "x-allOf-name": "equipment.IoCardIdentity", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoCardIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.IoCardIdentity" ], "default": "equipment.IoCardIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.IoCardIdentity" ], "default": "equipment.IoCardIdentity", "x-enum-as-string": true }, "IoCardMoid": { "description": "MO Reference to equipmentIoCard MO in inventory service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Lifecycle": { "description": "IO Card inventory lifecycle status.\n* `Unknown` - Default lifecycle state of a iocard. This should be an initial state when no state is defined for a specific iocard.\n* `Decommissioned` - Lifecycle state is set to this value after the chassis is successfully decommissioned.\n* `DiscoveryInProgress` - Lifecycle state is set to this value after the successful start of the iocard connection discovery process.\n* `DiscoveryFailed` - Lifecycle state is set to this value after the iocard connection discovery has failed.\n* `DiscoveryCompleted` - Lifecycle state is set to this value after the connection discovery of the iocard is completed successfully.\n* `None` - Lifecycle state is set to this value before the start of connection discovery and inventory collection process for a iocard.\n* `InventoryCompleted` - Lifecycle state is set to this value after the chassis inventory collection process is completed for a specific iocard.\n* `InventoryInProgress` - Lifecycle state is set to this value after successful start of the chassis inventory collection process for a specific iocard.\n* `InventoryFailed` - Lifecycle state is set to this value after the chassis inventory collection process failed for a iocard.", "type": "string", "enum": [ "Unknown", "Decommissioned", "DiscoveryInProgress", "DiscoveryFailed", "DiscoveryCompleted", "None", "InventoryCompleted", "InventoryInProgress", "InventoryFailed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Model": { "description": "IO Card or intelligent fabric module model.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModuleId": { "description": "IOM/MUX Module ID connected to the FI.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NetworkElementMoid": { "description": "MO Reference to networkElement MO in inventory service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "IO Card or intelligent fabric module serial number.", "type": "string", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "Identifier of the Switch where the IOM is connected. ID can be either 1 or 2, equivalent to A or B.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "IO Card or intelligent fabric module vendor.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.IoCardOperation.Response": { "description": "The response body of a HTTP GET request for the 'equipment.IoCardOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.IoCardOperation' resources.", "x-one-of-name": "equipment.IoCardOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.IoCardOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.IoCardOperation": { "title": "IO Module Operations", "description": "Models the configurable properties of a iomodule in Intersight.", "x-allOf-name": "equipment.IoCardOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoCardOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.IoCardOperation" ], "default": "equipment.IoCardOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.IoCardOperation" ], "default": "equipment.IoCardOperation", "x-enum-as-string": true }, "AdminPeerPowerState": { "description": "User configured power state of the peer IO module.\n* `None` - Placeholder default value for iom power state property.\n* `Reboot` - IO Module reboot state property value.", "type": "string", "enum": [ "None", "Reboot" ], "default": "None", "x-omitempty": true }, "AdminPowerState": { "description": "User configured power state of the IO module.\n* `None` - Placeholder default value for iom power state property.\n* `Reboot` - IO Module reboot state property value.", "type": "string", "enum": [ "None", "Reboot" ], "default": "None", "x-omitempty": true }, "AffectedObjName": { "description": "Placeholder for affected object name which is a combination of chassis and IOM ID. Used to display affected object in audit log.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "The configured state of these settings in the target IO module. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target IO module. Applying - This state denotes that the settings are being applied in the target IO module. Failed - This state denotes that the settings could not be applied in the target IO module.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "IoCardOperationStatus": { "type": "array", "items": { "description": "The status of completed and in-progress IO module operations.", "$ref": "#/components/schemas/equipment.IoCardOperationStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IoCard": { "$ref": "#/components/schemas/equipment.IoCard.Relationship", "description": "A reference to a equipmentIoCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.IoCardOperation.List": { "title": "List of 'equipment.IoCardOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.IoCardOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.IoCardOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoCardOperation" }, "nullable": true } } } ] }, "equipment.IoCardOperationStatus": { "title": "Equipment:Io Card Operation Status", "description": "The status of completed and in-progress operations performed on the IO Card.", "x-allOf-name": "equipment.IoCardOperationStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoCardOperationStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.IoCardOperationStatus" ], "default": "equipment.IoCardOperationStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.IoCardOperationStatus" ], "default": "equipment.IoCardOperationStatus", "x-enum-as-string": true }, "ConfigState": { "description": "The configured state of the settings in the target IO Card. The value is any one of Applied, Applying or Failed. Applied - The state denotes that the settings are applied successfully in the target IO Card. Applying - The state denotes that the settings are being applied in the target IO Card. Failed - The state denotes that the settings could not be applied in the target IO Card.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "readOnly": true, "x-omitempty": true }, "WorkflowId": { "description": "The workflow Id of the IO Card operations workflow.", "type": "string", "readOnly": true, "x-omitempty": true }, "WorkflowType": { "description": "The workflow type of the IO Card operation workflow. This can be used to distinguish different IO Card operations.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.IoExpander.Response": { "description": "The response body of a HTTP GET request for the 'equipment.IoExpander' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.IoExpander' resources.", "x-one-of-name": "equipment.IoExpander.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.IoExpander.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.IoExpander.Relationship": { "description": "A relationship to the 'equipment.IoExpander' resource, or the expanded 'equipment.IoExpander' resource, or the 'null' value.", "x-one-of-name": "equipment.IoExpander.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.IoExpander" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.IoExpander": { "title": "Equipment:Io Expander", "description": "The equipment.IoExpander object represents an I/O expander card, which serves as an extension for servers, particularly within a Colusa-type chassis architecture.\n#### Purpose\nThe primary purpose of this object is to inventory and report the status of an I/O expander card. These cards provide additional I/O capabilities or connectivity options for the servers they are attached to. The object captures the expander's identity and its operational state.\n#### Key Concepts\n- **I/O Extension:** Models a card that expands the I/O capabilities of a server.\n- **State Reporting:** The operState property provides the current operational status of the expander card.\n- **Hardware Inventory:** Captures the base identity of the card, including its model, vendor, and serial number.\n- **Server Component:** It is a child of a compute.Blade, linking it directly to the server it expands.", "x-allOf-name": "equipment.IoExpander", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.IoExpander', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.IoExpander" ], "default": "equipment.IoExpander", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.IoExpander" ], "default": "equipment.IoExpander", "x-enum-as-string": true }, "OperState": { "description": "Identifies the operational state of I/O expander.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.IoExpander.List": { "title": "List of 'equipment.IoExpander' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.IoExpander' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.IoExpander' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.IoExpander" }, "nullable": true } } } ] }, "equipment.LocatorLed.Response": { "description": "The response body of a HTTP GET request for the 'equipment.LocatorLed' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.LocatorLed' resources.", "x-one-of-name": "equipment.LocatorLed.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.LocatorLed.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.LocatorLed.Relationship": { "description": "A relationship to the 'equipment.LocatorLed' resource, or the expanded 'equipment.LocatorLed' resource, or the 'null' value.", "x-one-of-name": "equipment.LocatorLed.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.LocatorLed" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.LocatorLed": { "title": "Equipment:Locator Led", "description": "The equipment.LocatorLed object represents the physical locator LED (Light Emitting Diode) on a piece of equipment, such as a server, chassis, or Fabric Interconnect.\n#### Purpose\nThe main function of this object is to inventory and control the state of a locator LED. The locator LED is a visual indicator used by data center technicians to physically identify a specific piece of hardware among many others in a rack. It allows an administrator to remotely turn the LED on or off.\n#### Key Concepts\n- **Physical Identification:** Provides a mechanism to visually identify hardware in a data center.\n- **State Control:** While the operState property is read-only in the inventory model, it is the target of actions that change the LED's state (typically \"on\" or \"off\").\n- **Visual Feedback:** The color property reports the color of the LED, which is often blue.\n- **Broad Applicability:** Can be associated with various types of equipment, including compute.RackUnit, compute.Blade, equipment.Chassis, and network.Element.", "x-allOf-name": "equipment.LocatorLed", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.LocatorLed', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.LocatorLed" ], "default": "equipment.LocatorLed", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.LocatorLed" ], "default": "equipment.LocatorLed", "x-enum-as-string": true }, "Color": { "description": "Color of the locatorled available on an equipment.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Identifies the operational state of locatorled.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentFex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkSecureRouter": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship", "description": "A reference to a networkSecureRouter resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StoragePhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.LocatorLed.List": { "title": "List of 'equipment.LocatorLed' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.LocatorLed' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.LocatorLed' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.LocatorLed" }, "nullable": true } } } ] }, "equipment.LogDownload.Response": { "description": "The response body of a HTTP GET request for the 'equipment.LogDownload' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.LogDownload' resources.", "x-one-of-name": "equipment.LogDownload.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.LogDownload.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.LogDownload": { "title": "Equipment:Log Download", "description": "The LogDownload object facilitates the download of collected logs from Cisco endpoints. It supports efficient retrieval and management of log files.\n#### Purpose\nLogDownload enables users to access and download logs collected from endpoints, aiding in troubleshooting and data management. It is a key component in log retrieval processes within Cisco environments.\n#### Key Concepts\n- **Log Retrieval:** Provides mechanisms for downloading logs from endpoints, supporting efficient access to collected data.\n- **Access Control:** Establishes privilege sets for log download operations, ensuring secure management.\n- **Integration with Devices:** Connects with servers to ensure log downloads are associated correctly within the network.\n- **Security:** Ensures log downloads are performed securely, supporting compliance and data integrity.", "x-allOf-name": "equipment.LogDownload", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.LogDownload', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.LogDownload" ], "default": "equipment.LogDownload", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.LogDownload" ], "default": "equipment.LogDownload", "x-enum-as-string": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.LogDownload.List": { "title": "List of 'equipment.LogDownload' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.LogDownload' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.LogDownload' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.LogDownload" }, "nullable": true } } } ] }, "equipment.PendingWorkflowTrigger": { "title": "Equipment:Pending Workflow Trigger", "description": "A workflow trigger that is waiting for a response from the workflow engine.", "x-allOf-name": "equipment.PendingWorkflowTrigger", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "equipment.PhysicalIdentity.Relationship": { "description": "A relationship to the 'equipment.PhysicalIdentity' resource, or the expanded 'equipment.PhysicalIdentity' resource, or the 'null' value.", "x-one-of-name": "equipment.PhysicalIdentity.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.PhysicalIdentity" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.PhysicalIdentity": { "title": "Equipment:Physical Identity", "description": "An Abstract Identity object that uniquely represents a server object under a DR.", "x-allOf-name": "equipment.PhysicalIdentity", "allOf": [ { "$ref": "#/components/schemas/equipment.Identity" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.PhysicalIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ExpanderModuleIdentity", "equipment.FexIdentity" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "compute.BladeIdentity", "compute.RackUnitIdentity", "equipment.ExpanderModuleIdentity", "equipment.FexIdentity" ], "x-enum-as-string": true }, "LastDiscoveryTriggered": { "description": "Denotes the type of discovery that was most recently triggered on this server.\n* `Unknown` - The last discovery type is unknown.\n* `Deep` - The last discovery triggered is deep.\n* `Shallow` - The last discovery triggered is shallow.", "type": "string", "enum": [ "Unknown", "Deep", "Shallow" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ResetToDefault": { "description": "Specifies whether device configurations need to be reset to default upon first-time discovery or recommission of a server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PhysicalDeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Psu.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Psu' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Psu' resources.", "x-one-of-name": "equipment.Psu.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Psu.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Psu.Relationship": { "description": "A relationship to the 'equipment.Psu' resource, or the expanded 'equipment.Psu' resource, or the 'null' value.", "x-one-of-name": "equipment.Psu.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Psu" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Psu": { "title": "Equipment:Psu", "description": "The equipment.Psu object represents a Power Supply Unit, a fundamental component responsible for providing electrical power to a server, chassis, or network switch.\n#### Purpose\nThe Psu object is used to inventory and monitor the state of an individual power supply. It captures key identity information (model, serial, part number), its operational state (operState), and detailed health information. It is critical for power management, redundancy monitoring, and fault detection.\n#### Key Concepts\n- **Power Component Inventory:** Provides a detailed record of each PSU in a system.\n- **Health and Status Monitoring:** Reports its operState and a collection of operReason values that give specific details on issues like temperature thresholds, input voltage problems, or output current faults.\n- **Redundancy Management:** The spareStatus property can indicate if the PSU is acting as a spare in a redundant configuration.\n- **Hierarchical Context:** Exists as a child of the equipment it powers, such as an equipment.Chassis, compute.RackUnit, or network.Element.", "x-allOf-name": "equipment.Psu", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Psu', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Psu" ], "default": "equipment.Psu", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Psu" ], "default": "equipment.Psu", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description for the power supply unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "This field is to provide name for the power supply unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Power supply unit.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field identifies the psu operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field identifies the Part Number for this Power Supply Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for the Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "PsuFwVersion": { "description": "This field identifies the Firmware Version of the Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "PsuId": { "description": "This represents power supply unit identifier in chassis/server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PsuInputSrc": { "description": "This field identifies the input source for the Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "PsuType": { "description": "This field identifies the type of the Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "PsuWattage": { "description": "This field identifies the Wattage of the Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stockkeeping Unit for this Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpareStatus": { "description": "This field identifies whether the power supply unit is spare or not.\n* `` - Spare status for power supply unit is not applicable or not available.\n* `Spare` - Power supply unit is spare.\n* `Not Spare` - Power supply unit is not spare.", "type": "string", "enum": [ "", "Spare", "Not Spare" ], "default": "", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the Vendor ID for this Power Supply Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Voltage": { "description": "This field is used to indicate the voltage state for this Power Supply.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentFex": { "$ref": "#/components/schemas/equipment.Fex.Relationship", "description": "A reference to a equipmentFex resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentRackEnclosure": { "$ref": "#/components/schemas/equipment.RackEnclosure.Relationship", "description": "A reference to a equipmentRackEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FirmwareRunningFirmwares": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Psu.List": { "title": "List of 'equipment.Psu' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Psu' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Psu' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Psu" }, "nullable": true } } } ] }, "equipment.PsuControl.Response": { "description": "The response body of a HTTP GET request for the 'equipment.PsuControl' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.PsuControl' resources.", "x-one-of-name": "equipment.PsuControl.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.PsuControl.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.PsuControl.Relationship": { "description": "A relationship to the 'equipment.PsuControl' resource, or the expanded 'equipment.PsuControl' resource, or the 'null' value.", "x-one-of-name": "equipment.PsuControl.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.PsuControl" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.PsuControl": { "title": "Equipment:Psu Control", "description": "The equipment.PsuControl object represents the overall power state and redundancy configuration of the Power Supply Units (PSUs) within a chassis.\n#### Purpose\nThe primary function of this object is to provide a consolidated view of the chassis's power redundancy status. It reports on the collective state of the PSUs, including the overall redundancy mode (redundancy), the input and output power states, and any system-level power-related health issues.\n#### Key Concepts\n- **System-Level Power State:** Aggregates the status of all PSUs in a chassis into a single management object.\n- **Redundancy Monitoring:** The redundancy and clusterState properties are key indicators of the chassis's power fault tolerance (e.g., N+1, non-redundant).\n- **Health Aggregation:** The operReason property provides details on chassis-wide power issues, such as a loss of redundancy (PsuRedundancyLostCritical).\n- **Chassis-Specific:** It is a child of an equipment.Chassis, providing a summary of the power subsystem for that specific enclosure.", "x-allOf-name": "equipment.PsuControl", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.PsuControl', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.PsuControl" ], "default": "equipment.PsuControl", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.PsuControl" ], "default": "equipment.PsuControl", "x-enum-as-string": true }, "ClusterState": { "description": "This field identifies the cluster state of the psu redundancy.", "type": "string", "readOnly": true, "x-omitempty": true }, "InputPowerState": { "description": "This field identifies the input power state of the psus.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "This field identifies the name of psu control object.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperQualifier": { "description": "This field identifies the operational qualifier for the psu redundancy.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the chassis power state.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This field identifies the operational state of the psu redundancy.", "type": "string", "readOnly": true, "x-omitempty": true }, "OutputPowerState": { "description": "This field identifies the output power state of the psus.", "type": "string", "readOnly": true, "x-omitempty": true }, "Redundancy": { "description": "This field identifies the redundancy state of the psus.", "type": "string", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.PsuControl.List": { "title": "List of 'equipment.PsuControl' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.PsuControl' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.PsuControl' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.PsuControl" }, "nullable": true } } } ] }, "equipment.RackEnclosure.Response": { "description": "The response body of a HTTP GET request for the 'equipment.RackEnclosure' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.RackEnclosure' resources.", "x-one-of-name": "equipment.RackEnclosure.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.RackEnclosure.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.RackEnclosure.Relationship": { "description": "A relationship to the 'equipment.RackEnclosure' resource, or the expanded 'equipment.RackEnclosure' resource, or the 'null' value.", "x-one-of-name": "equipment.RackEnclosure.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.RackEnclosure" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.RackEnclosure": { "title": "Equipment:Rack Enclosure", "description": "The equipment.RackEnclosure object represents a physical enclosure that houses multiple rack-mounted servers, providing shared infrastructure like power and cooling.\n#### Purpose\nThe RackEnclosure object serves as a container and management entity for a group of rack servers that are part of a single physical unit. This provides a way to inventory the enclosure itself and acts as a parent for the components it contains, such as equipment.RackEnclosureSlot objects, equipment.Psu units, and equipment.FanModule modules.\n#### Key Concepts\n- **Server Aggregation:** Groups multiple rack servers into a single managed enclosure.\n- **Hierarchical Inventory:** Provides a structured parent-child relationship to its contained slots, PSUs, and fan modules.\n- **Unique Identification:** Identified by a system-assigned enclosureId.\n- **Shared Infrastructure Model:** Represents the shared resources (power, cooling) that are common to all servers within the enclosure.", "x-allOf-name": "equipment.RackEnclosure", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.RackEnclosure', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.RackEnclosure" ], "default": "equipment.RackEnclosure", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.RackEnclosure" ], "default": "equipment.RackEnclosure", "x-enum-as-string": true }, "EnclosureId": { "description": "This represents the Enclosure Identifier for Rack servers.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Fanmodules": { "description": "An array of relationships to equipmentFanModule resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.FanModule.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Psus": { "description": "An array of relationships to equipmentPsu resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Psu.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Slots": { "description": "An array of relationships to equipmentRackEnclosureSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "equipment.RackEnclosure.List": { "title": "List of 'equipment.RackEnclosure' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.RackEnclosure' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.RackEnclosure' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.RackEnclosure" }, "nullable": true } } } ] }, "equipment.RackEnclosureSlot.Response": { "description": "The response body of a HTTP GET request for the 'equipment.RackEnclosureSlot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.RackEnclosureSlot' resources.", "x-one-of-name": "equipment.RackEnclosureSlot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.RackEnclosureSlot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.RackEnclosureSlot.Relationship": { "description": "A relationship to the 'equipment.RackEnclosureSlot' resource, or the expanded 'equipment.RackEnclosureSlot' resource, or the 'null' value.", "x-one-of-name": "equipment.RackEnclosureSlot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.RackEnclosureSlot": { "title": "Equipment:Rack Enclosure Slot", "description": "The equipment.RackEnclosureSlot object represents a physical slot within a rack enclosure that is designed to hold a rack-mounted server.\n#### Purpose\nThe main function of this object is to model the individual server slots within a larger rack enclosure. It establishes the link between a physical slot and the compute.RackUnit that occupies it. It is essential for accurately representing the physical topology of the enclosure and its contained servers.\n#### Key Concepts\n- **Physical Slot Representation:** Models a single server bay within a rack enclosure.\n- **Server-to-Slot Mapping:** The relationship to a compute.RackUnit and the rackUnitDn property create the explicit link between the server and its physical location.\n- **Location Identification:** The rackId property (equivalent to the server ID) and its parent equipment.RackEnclosure uniquely identify the slot's position.\n- **Hierarchical Structure:** Exists as a child of an equipment.RackEnclosure, forming part of the overall enclosure inventory.", "x-allOf-name": "equipment.RackEnclosureSlot", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.RackEnclosureSlot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.RackEnclosureSlot" ], "default": "equipment.RackEnclosureSlot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.RackEnclosureSlot" ], "default": "equipment.RackEnclosureSlot", "x-enum-as-string": true }, "RackId": { "description": "Server ID which is part of Rack Enclosure Slot.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RackUnitDn": { "description": "Server DN which is part of Rack Enclosure Slot.", "type": "string", "readOnly": true, "x-omitempty": true }, "EquipmentRackEnclosure": { "$ref": "#/components/schemas/equipment.RackEnclosure.Relationship", "description": "A reference to a equipmentRackEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.RackEnclosureSlot.List": { "title": "List of 'equipment.RackEnclosureSlot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.RackEnclosureSlot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.RackEnclosureSlot' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.RackEnclosureSlot" }, "nullable": true } } } ] }, "equipment.ResetAction": { "title": "Equipment:Reset Action", "description": "An action to initiate a reboot of the Fabric Interconnect with an option to perform fabric evacuation beforehand.", "x-allOf-name": "equipment.ResetAction", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.ResetAction', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.ResetAction" ], "default": "equipment.ResetAction", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.ResetAction" ], "default": "equipment.ResetAction", "x-enum-as-string": true }, "Action": { "description": "The reboot behavior for the Fabric Interconnect. Reboot - An action to reset the Fabric Interconnect by initiating its reboot. ForceReboot - Forces an immediate reboot of the Fabric Interconnect, overriding normal reboot validation checks. None - No reboot action should be triggered on the the Fabric Interconnect.\n* `None` - No action to be triggered on the Fabric Interconnect.\n* `Reboot` - An action to reset the Fabric Interconnect by initiating its reboot.\n* `ForceReboot` - An action to enforce an immediate reboot of the Fabric Interconnect regardless of existing validation checks.By default, a reset action is not allowed on an Fabric Interconnect if Domain Profile deployment, Manual Data Evacuation, or a reset action on the peer FI is already in progress. The force option allows users to override this check and perform the reset action on the FI.", "type": "string", "enum": [ "None", "Reboot", "ForceReboot" ], "default": "None", "x-omitempty": true }, "EnableFabricEvacuation": { "description": "The flag to enable or disable fabric evacuation before rebooting the Fabric Interconnect.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "equipment.Riser.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Riser' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Riser' resources.", "x-one-of-name": "equipment.Riser.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Riser.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Riser.Relationship": { "description": "A relationship to the 'equipment.Riser' resource, or the expanded 'equipment.Riser' resource, or the 'null' value.", "x-one-of-name": "equipment.Riser.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Riser" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Riser": { "title": "Equipment:Riser", "description": "The equipment.Riser object represents a server riser assembly that provides physical expansion capability and a mounting/connection point for manageable sub-components. In practice, risers commonly expose PCIe expansion options and may also represent specialized backplane-style assemblies depending on the platform.\n#### Purpose\nequipment.Riser inventories a riser's identity and characteristics so consumers can understand what expansion/backplane hardware is present in a server and how it contributes to the system's physical configuration.\n#### Key Concepts\n- **Expansion topology element:** Represents a physical assembly that enables/hosts expansion connectivity.\n- **Variant coverage:** Can represent standard PCIe risers as well as platform-specific riser/backplane variants.\n- **Hardware characterization:** Conveys high-level attributes such as form factor and PCIe generation for capability awareness.\n- **Server association:** Anchored under a compute blade or rack unit to map risers to the server they belong to.", "x-allOf-name": "equipment.Riser", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Riser', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Riser" ], "default": "equipment.Riser", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Riser" ], "default": "equipment.Riser", "x-enum-as-string": true }, "Description": { "description": "This field is to provide description for the Riser.", "type": "string", "readOnly": true, "x-omitempty": true }, "FormFactor": { "description": "This field is to provide formFactor for the Riser.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the pluggable Riser.", "type": "string", "readOnly": true, "x-omitempty": true }, "PcieType": { "description": "This field is to provide pcieType for the Riser.", "type": "string", "readOnly": true, "x-omitempty": true }, "Sku": { "description": "This field identifies the Stockkeeping Unit for this Riser.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the Riser slot in the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Riser.List": { "title": "List of 'equipment.Riser' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Riser' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Riser' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Riser" }, "nullable": true } } } ] }, "equipment.Sensor.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Sensor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Sensor' resources.", "x-one-of-name": "equipment.Sensor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Sensor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Sensor.Relationship": { "description": "A relationship to the 'equipment.Sensor' resource, or the expanded 'equipment.Sensor' resource, or the 'null' value.", "x-one-of-name": "equipment.Sensor.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Sensor" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Sensor": { "title": "Equipment:Sensor", "description": "The equipment.Sensor object represents a hardware sensor on a network device that monitors a specific environmental or operational metric, such as temperature, voltage, or fan speed.\n#### Purpose\nThe primary purpose of the Sensor object is to provide inventory and real-time status for the various sensors within a network device. It reports the sensor's name and its current alarmStatus (e.g., \"normal\", \"minor\", \"major\", \"failed\"). It is fundamental for health monitoring and proactive fault detection.\n#### Key Concepts\n- **Health Monitoring:** Provides the status of individual hardware sensors, which is a key input for the overall health status of a device.\n- **Threshold-Based Alarms:** The alarmStatus reflects whether the sensor's readings have crossed predefined thresholds (minor or major), which can trigger alarms.\n- **Granular Inventory:** Allows for a detailed inventory of all monitoring points within a device.\n- **Device-Specific:** It is a child of a network.Element, providing sensor data for a specific switch.", "x-allOf-name": "equipment.Sensor", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Sensor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Sensor" ], "default": "equipment.Sensor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Sensor" ], "default": "equipment.Sensor", "x-enum-as-string": true }, "AlarmStatus": { "description": "The alarm status of the sensor.\n* `absent` - The sensor is absent on the device.\n* `failed` - The sensor in the device has failed.\n* `normal` - The sensor status is normal.\n* `minor` - The sensor has crossed minor threshold.\n* `major` - The sensor has crossed major threshold.\n* `bad-asic` - The sensor is in bad-asic state.", "type": "string", "enum": [ "absent", "failed", "normal", "minor", "major", "bad-asic" ], "default": "absent", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name or description of the sensor.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Sensor.List": { "title": "List of 'equipment.Sensor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Sensor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Sensor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Sensor" }, "nullable": true } } } ] }, "equipment.SharedAdapterUnit.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SharedAdapterUnit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SharedAdapterUnit' resources.", "x-one-of-name": "equipment.SharedAdapterUnit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SharedAdapterUnit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SharedAdapterUnit.Relationship": { "description": "A relationship to the 'equipment.SharedAdapterUnit' resource, or the expanded 'equipment.SharedAdapterUnit' resource, or the 'null' value.", "x-one-of-name": "equipment.SharedAdapterUnit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.SharedAdapterUnit" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.SharedAdapterUnit": { "title": "Equipment:Shared Adapter Unit", "description": "The shared physical adapter present on the XFM module.", "x-allOf-name": "equipment.SharedAdapterUnit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SharedAdapterUnit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SharedAdapterUnit" ], "default": "equipment.SharedAdapterUnit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SharedAdapterUnit" ], "default": "equipment.SharedAdapterUnit", "x-enum-as-string": true }, "AdapterId": { "description": "Unique Identifier of a shared adapter unit within a expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "Firmware version of the shared adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of shared adapter unit.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of the shared adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part number of a shared adapter unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "PCIe slot of the adapter in the chassis expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdapterUnits": { "description": "An array of relationships to adapterUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/adapter.Unit.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciEndpoint": { "$ref": "#/components/schemas/pci.Endpoint.Relationship", "description": "A reference to a pciEndpoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.SharedAdapterUnit.List": { "title": "List of 'equipment.SharedAdapterUnit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SharedAdapterUnit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SharedAdapterUnit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit" }, "nullable": true } } } ] }, "equipment.SharedGraphicsCard.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SharedGraphicsCard' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SharedGraphicsCard' resources.", "x-one-of-name": "equipment.SharedGraphicsCard.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SharedGraphicsCard.Relationship": { "description": "A relationship to the 'equipment.SharedGraphicsCard' resource, or the expanded 'equipment.SharedGraphicsCard' resource, or the 'null' value.", "x-one-of-name": "equipment.SharedGraphicsCard.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.SharedGraphicsCard" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.SharedGraphicsCard": { "title": "Equipment:Shared Graphics Card", "description": "Graphics card within a PCIe node that can be shared by one or more servers.", "x-allOf-name": "equipment.SharedGraphicsCard", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SharedGraphicsCard', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SharedGraphicsCard" ], "default": "equipment.SharedGraphicsCard", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SharedGraphicsCard" ], "default": "equipment.SharedGraphicsCard", "x-enum-as-string": true }, "Description": { "description": "The description of the GPU card.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The unique device identifier assigned by the vendor to a specific model of GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "The version of the GPU firmware.", "type": "string", "readOnly": true, "x-omitempty": true }, "GpuId": { "description": "The identifier of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of graphics card.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part number identifier for the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "PCIe slot of the GPU in the PCIe node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "The unique product ID associated with the GPU card.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubDeviceId": { "description": "The subsystem device identifier assigned by the subsystem vendor to a specific model of GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SubVendorId": { "description": "The unique vendor identifier assigned to the organization which integrates the GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VendorId": { "description": "The unique vendor identifier assigned to the manufacturer of the GPU.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EquipmentInterconnect": { "$ref": "#/components/schemas/equipment.Interconnect.Relationship", "description": "A reference to a equipmentInterconnect resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true, "readOnly": true }, "PciEndpoint": { "$ref": "#/components/schemas/pci.Endpoint.Relationship", "description": "A reference to a pciEndpoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.SharedGraphicsCard.List": { "title": "List of 'equipment.SharedGraphicsCard' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SharedGraphicsCard' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SharedGraphicsCard' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard" }, "nullable": true } } } ] }, "equipment.SharedIoModule.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SharedIoModule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SharedIoModule' resources.", "x-one-of-name": "equipment.SharedIoModule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SharedIoModule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SharedIoModule.Relationship": { "description": "A relationship to the 'equipment.SharedIoModule' resource, or the expanded 'equipment.SharedIoModule' resource, or the 'null' value.", "x-one-of-name": "equipment.SharedIoModule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.SharedIoModule" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.SharedIoModule": { "title": "Equipment:Shared Io Module", "description": "The equipment.SharedIoModule object represents a shared I/O module (SIOM), which is an adapter-like component typically found in a System I/O Controller (SIOC) for Cisco S-Series storage servers. This provides the data path from the server to the Fabric Interconnects.\n#### Purpose\n \nThe SharedIoModule object is used to inventory and manage the SIOM. It captures the module's identity, its operational state (operState), and its connectivity status (reachability) to the A and B sides of the fabric. It acts as a container for the network ports (port.Group objects).\n#### Key Concepts\n- **Storage Server Connectivity:** Models the specific I/O adapter used in S-Series servers.\n- **Redundancy and Reachability:** The reachability property indicates its connection status to both Fabric Interconnects, which is key for monitoring high availability.\n- **Hierarchical Inventory:** Serves as a parent for port.Group objects and is itself a child of an equipment.SystemIoController.\n- **Configuration State:** The configState property tracks its configuration status within the system.", "x-allOf-name": "equipment.SharedIoModule", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SharedIoModule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SharedIoModule" ], "default": "equipment.SharedIoModule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SharedIoModule" ], "default": "equipment.SharedIoModule", "x-enum-as-string": true }, "ConfigState": { "description": "This field identifies the configuration state for this SIOM Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Discovery": { "description": "This field identifies the discovery state of SIOM.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacOfSharedIomAside": { "description": "This field identifies the MAC of IOM-A side.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacOfSharedIomBside": { "description": "This field identifies the MAC of IOM-B side.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "This field identifies the SIOM operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field identifies the Part Number for this SIOM Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Reachability": { "description": "This field identifies the reachability to FI-A and B side.", "type": "string", "readOnly": true, "x-omitempty": true }, "UsrLbl": { "description": "User label configured for the SIOM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "This field identifies the vendor id for this SIOM Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Controller": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentSystemIoController": { "$ref": "#/components/schemas/equipment.SystemIoController.Relationship", "description": "A reference to a equipmentSystemIoController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PortGroups": { "description": "An array of relationships to portGroup resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/port.Group.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.SharedIoModule.List": { "title": "List of 'equipment.SharedIoModule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SharedIoModule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SharedIoModule' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedIoModule" }, "nullable": true } } } ] }, "equipment.Slot": { "title": "Equipment:Slot", "description": "Abstract base class for all slots available on the system.", "x-allOf-name": "equipment.Slot", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Slot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "equipment.HybridDriveSlot", "storage.DiskSlot" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "equipment.HybridDriveSlot", "storage.DiskSlot" ], "x-enum-as-string": true }, "SlotId": { "description": "This field identifies a specific slot on the server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "equipment.SwitchCard.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SwitchCard' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SwitchCard' resources.", "x-one-of-name": "equipment.SwitchCard.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SwitchCard.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SwitchCard.Relationship": { "description": "A relationship to the 'equipment.SwitchCard' resource, or the expanded 'equipment.SwitchCard' resource, or the 'null' value.", "x-one-of-name": "equipment.SwitchCard.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.SwitchCard" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.SwitchCard": { "title": "Equipment:Switch Card", "description": "The equipment.SwitchCard object represents a physical module, either fixed or removable, within a Fabric Interconnect or network switch. This can be a main supervisor card or a line card that provides network ports.\n#### Purpose\nThe SwitchCard object serves as a primary inventory entity for the major modules within a switch. It captures the card's identity (model, serial), its operational state, and its physical location (slotId). It also acts as a container for the network interfaces this provides, such as port.Group, ether.PortChannel, and fc.PhysicalPort objects.\n#### Key Concepts\n- **Modular Switch Inventory:** Models the physical cards that make up a modular switch or Fabric Interconnect.\n- **Hierarchical Port Container:** Acts as the parent for all physical and logical ports that reside on the card, providing a structured view of the switch's interfaces.\n- **Health and Status:** The state and status properties report on the operational health of the card itself.\n- **Switching Mode Configuration:** Reports the configured ethernetSwitchingMode and fcSwitchingMode (End-Host or Switch), which defines the fundamental behavior of the Fabric Interconnect.", "x-allOf-name": "equipment.SwitchCard", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SwitchCard', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SwitchCard" ], "default": "equipment.SwitchCard", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SwitchCard" ], "default": "equipment.SwitchCard", "x-enum-as-string": true }, "BaseMac": { "description": "The starting (base) MAC address of the switch hardware like \"d0-e0-42-87-39-00\".", "type": "string", "x-omitempty": true }, "Description": { "description": "Detailed description of this switch hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "EndMac": { "description": "The ending MAC address of the switch hardware like \"d0-e0-42-87-39-5f\".", "type": "string", "x-omitempty": true }, "EthernetSwitchingMode": { "description": "The user configured Ethernet switching mode for this switch (End-Host or Switch).\n* `end-host` - In end-host mode, the fabric interconnects appear to the upstream devices as end hosts with multiple links.In this mode, the switch does not run Spanning Tree Protocol and avoids loops by following a set of rules for traffic forwarding.In case of ethernet switching mode - Ethernet end-host mode is also known as Ethernet host virtualizer.\n* `switch` - In switch mode, the switch runs Spanning Tree Protocol to avoid loops, and broadcast and multicast packets are handled in the traditional way.This is the traditional switch mode.", "type": "string", "enum": [ "end-host", "switch" ], "default": "end-host", "readOnly": true, "x-omitempty": true }, "FcSwitchingMode": { "description": "The user configured FC switching mode for this switch (End-Host or Switch).\n* `end-host` - In end-host mode, the fabric interconnects appear to the upstream devices as end hosts with multiple links.In this mode, the switch does not run Spanning Tree Protocol and avoids loops by following a set of rules for traffic forwarding.In case of ethernet switching mode - Ethernet end-host mode is also known as Ethernet host virtualizer.\n* `switch` - In switch mode, the switch runs Spanning Tree Protocol to avoid loops, and broadcast and multicast packets are handled in the traditional way.This is the traditional switch mode.", "type": "string", "enum": [ "end-host", "switch" ], "default": "end-host", "readOnly": true, "x-omitempty": true }, "HwVersion": { "description": "The Hardware version of the switch hardware.", "type": "string", "x-omitempty": true }, "JumboFrameEnabled": { "description": "Jumbo Frame configuration for the switch.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the switch card like Line Card-1.", "type": "string", "x-omitempty": true }, "NumPorts": { "description": "Number of ports present in this switch hardware.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OutOfBandIpAddress": { "description": "Field specifies this Switch's Out-of-band IP address.", "type": "string", "readOnly": true, "x-omitempty": true }, "OutOfBandIpGateway": { "description": "Field specifies this Switch's default gateway for the out-of-band management interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "OutOfBandIpMask": { "description": "Field specifies the Netmask for this Switch's Out-of-band IP address.", "type": "string", "x-omitempty": true }, "OutOfBandMac": { "description": "The MAC address of the Switch's out-of-band management interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "The part number of the switch hardware.", "type": "string", "x-omitempty": true }, "PowerState": { "description": "Power state of the switch hardware.\n* `unknown` - The power state of the switch hardware is unknown.\n* `off` - The power state of the switch hardware is off.\n* `on` - The power state of the switch hardware is on.\n* `deny` - The power state of the switch hardware is deny.\n* `multi-boot-fail` - The power state of the switch hardware is multi-boot-fail.", "type": "string", "enum": [ "unknown", "off", "on", "deny", "multi-boot-fail" ], "default": "unknown", "x-omitempty": true }, "SlotId": { "description": "Slot identifier of the SwitchCard within the Switch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "State": { "description": "Operational state of the switch hardware.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The connection status of the switch hardware like up/down.\n* `Down` - Connection status of the switch card is down.\n* `Up` - Connection status of the switch card is up.", "type": "string", "enum": [ "Down", "Up" ], "default": "Down", "x-omitempty": true }, "StpMode": { "description": "Spanning Tree Protocol configuration for the switch.\n* `Disabled` - Spanning Tree Protocol (STP) is disabled.\n* `STP` - Spanning Tree Protocol (STP) is enabled and operating in STP.\n* `RSTP` - Spanning Tree Protocol (STP) is enabled and operating in RSTP mode.\n* `MSTP` - Spanning Tree Protocol (STP) is enabled and operating in MSTP mode.\n* `PVST+` - Spanning Tree Protocol (STP) is enabled and operating in PVST mode.\n* `RPVST+` - Spanning Tree Protocol (STP) is enabled and operating in RPVST mode.", "type": "string", "enum": [ "Disabled", "STP", "RSTP", "MSTP", "PVST+", "RPVST+" ], "default": "Disabled", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "Switch Identifier that is local to a cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "The Thermal status of the fabric interconnect.\n* `unknown` - The default state of the sensor (in case no data is received).\n* `ok` - State of the sensor indicating the sensor's temperature range is okay.\n* `upper-non-recoverable` - State of the sensor indicating that the temperature is extremely high above normal range.\n* `upper-critical` - State of the sensor indicating that the temperature is above normal range.\n* `upper-non-critical` - State of the sensor indicating that the temperature is a little above the normal range.\n* `lower-non-critical` - State of the sensor indicating that the temperature is a little below the normal range.\n* `lower-critical` - State of the sensor indicating that the temperature is below normal range.\n* `lower-non-recoverable` - State of the sensor indicating that the temperature is extremely below normal range.", "type": "string", "enum": [ "unknown", "ok", "upper-non-recoverable", "upper-critical", "upper-non-critical", "lower-non-critical", "lower-critical", "lower-non-recoverable" ], "default": "unknown", "x-omitempty": true }, "Type": { "description": "Type of the switch card based on the capability like 4 Gbps or 2 Gbps type etc.", "type": "string", "x-omitempty": true }, "FcPortChannels": { "description": "An array of relationships to fcPortChannel resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fc.PortChannel.Relationship" }, "nullable": true }, "FcPorts": { "description": "An array of relationships to fcPhysicalPort resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fc.PhysicalPort.Relationship" }, "nullable": true }, "HostPorts": { "description": "An array of relationships to etherHostPort resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.HostPort.Relationship" }, "nullable": true }, "InterSwitchPort": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.InterSwitchPort.Relationship", "description": "A reference to a etherInterSwitchPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PortChannels": { "description": "An array of relationships to etherPortChannel resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.PortChannel.Relationship" }, "nullable": true }, "PortGroups": { "description": "An array of relationships to portGroup resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/port.Group.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.SwitchCard.List": { "title": "List of 'equipment.SwitchCard' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SwitchCard' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SwitchCard' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SwitchCard" }, "nullable": true } } } ] }, "equipment.SwitchOperation.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SwitchOperation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SwitchOperation' resources.", "x-one-of-name": "equipment.SwitchOperation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SwitchOperation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SwitchOperation": { "title": "Switch Operations", "description": "Models the operational states of a Switch in Intersight.", "x-allOf-name": "equipment.SwitchOperation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SwitchOperation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SwitchOperation" ], "default": "equipment.SwitchOperation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SwitchOperation" ], "default": "equipment.SwitchOperation", "x-enum-as-string": true }, "AdminEvacState": { "description": "Sets evacuation state of the switch. When evacuation is enabled, data traffic flowing through this switch will be suspended for all the servers. Fabric evacuation can be enabled during any maintenance activity on the switch in order to gracefully failover data flows to the peer switch.\n* `Disabled` - Admin configured Disabled State.\n* `Enabled` - Admin configured Enabled State.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true }, "AdminLocatorLedAction": { "description": "Action performed on the locator LED of the switch.\n* `None` - No operation action for the Locator Led of an equipment.\n* `TurnOn` - Turn on the Locator Led of an equipment.\n* `TurnOff` - Turn off the Locator Led of an equipment.", "type": "string", "enum": [ "None", "TurnOn", "TurnOff" ], "default": "None", "x-omitempty": true }, "AdminLocatorLedActionState": { "description": "Defines status of action performed on AdminLocatorLedState.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "x-omitempty": true }, "ConfigEvacState": { "description": "Captures the status of evacuation on this switch.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "x-omitempty": true }, "ForceEvac": { "description": "Evacuation is blocked by the system if it can cause a traffic outage in the domain. Select \"Force Evacuation\" only if system rejects the operation and you want to override that.", "type": "boolean", "x-omitempty": true }, "ResetAction": { "description": "An action to initiate a reboot of the Fabric Interconnect with an optional fabric evacuation beforehand.", "$ref": "#/components/schemas/equipment.ResetAction", "x-omitempty": true }, "ResetActionState": { "description": "Current status of the reset operation executed on the Fabric Interconnect.\n* `None` - Nil value when no action has been triggered by the user.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Failed` - User configured settings could not be applied.\n* `Scheduled` - User configured settings are scheduled to be applied.", "type": "string", "enum": [ "None", "Applied", "Applying", "Failed", "Scheduled" ], "default": "None", "x-omitempty": true }, "SwitchName": { "description": "Name of the switch on which the switch operation is performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.SwitchOperation.List": { "title": "List of 'equipment.SwitchOperation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SwitchOperation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SwitchOperation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SwitchOperation" }, "nullable": true } } } ] }, "equipment.SystemIoController.Response": { "description": "The response body of a HTTP GET request for the 'equipment.SystemIoController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.SystemIoController' resources.", "x-one-of-name": "equipment.SystemIoController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.SystemIoController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.SystemIoController.Relationship": { "description": "A relationship to the 'equipment.SystemIoController' resource, or the expanded 'equipment.SystemIoController' resource, or the 'null' value.", "x-one-of-name": "equipment.SystemIoController.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.SystemIoController" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.SystemIoController": { "title": "Equipment:System Io Controller", "description": "The equipment.SystemIoController (SIOC) object represents an I/O controller on a chassis, specifically designed to provide the data path for Cisco S-Series storage servers.\n#### Purpose\nThe SystemIoController object is the primary inventory and management entity for a SIOC. It models the controller that connects an S-Series server to the fabric. It captures the SIOC's identity, its operational state (operState), and its connection path to the Fabric Interconnects. It also serves as the container for the equipment.SharedIoModule (SIOM) that it houses.\n#### Key Concepts\n- **Storage Server I/O:** Represents the specialized I/O component for S-Series servers.\n- **Hierarchical Inventory:** Acts as the parent container for the equipment.SharedIoModule and the chassis management controller (management.Controller) associated with it.\n- **Connectivity Status:** The connectionPath and connectionStatus properties track its link to the upstream fabric.\n- **Chassis Component:** It is a child of an equipment.Chassis, defining its location within the storage server chassis.", "x-allOf-name": "equipment.SystemIoController", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.SystemIoController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.SystemIoController" ], "default": "equipment.SystemIoController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.SystemIoController" ], "default": "equipment.SystemIoController", "x-enum-as-string": true }, "ChassisId": { "description": "The assigned identifier for a chassis.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionPath": { "description": "Connection Path identifies the data path available between IOModule and FI.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionStatus": { "description": "Connection status identifies the status of data path.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field gives a brief information on systemIOController.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagingInstance": { "description": "This field identifies the CIMC that manages the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "This field identifies the SIOC operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Part Number identifier for the IO module.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for systemIOController.", "type": "string", "readOnly": true, "x-omitempty": true }, "SystemIoControllerId": { "description": "This represents system I/O Controller identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Cmc": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedIoModule": { "$ref": "#/components/schemas/equipment.SharedIoModule.Relationship", "description": "A reference to a equipmentSharedIoModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "equipment.SystemIoController.List": { "title": "List of 'equipment.SystemIoController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.SystemIoController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.SystemIoController' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SystemIoController" }, "nullable": true } } } ] }, "equipment.Tpm.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Tpm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Tpm' resources.", "x-one-of-name": "equipment.Tpm.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Tpm.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Tpm.Relationship": { "description": "A relationship to the 'equipment.Tpm' resource, or the expanded 'equipment.Tpm' resource, or the 'null' value.", "x-one-of-name": "equipment.Tpm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/equipment.Tpm" } ], "discriminator": { "propertyName": "ClassId" } }, "equipment.Tpm": { "title": "Equipment:Tpm", "description": "The equipment.Tpm object represents a Trusted Platform Module (TPM) security chip installed on a server's motherboard. A TPM is a hardware-based security component that provides secure storage for cryptographic keys, platform integrity measurements, and authentication.\n#### Purpose\nThe Tpm object is used to inventory and report the status of the TPM on a server. It captures key information such as the TPM version, its activationStatus, and its administrative state (adminState). It is essential for security auditing and for enabling features that rely on hardware-based trust, such as secure boot and measured boot.\n#### Key Concepts\n- **Hardware Security Inventory:** Provides a detailed record of the server's TPM chip.\n- **Security State Reporting:** The activationStatus and ownership properties indicate the current security state of the TPM.\n- **Firmware and Versioning:** Captures the firmwareVersion and TPM specification version (e.g., \"2.0\").\n- **Server Component:** It is a child of a compute.Board, linking the TPM directly to the motherboard it is part of.", "x-allOf-name": "equipment.Tpm", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Tpm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Tpm" ], "default": "equipment.Tpm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Tpm" ], "default": "equipment.Tpm", "x-enum-as-string": true }, "ActivationStatus": { "description": "Identifies the activation status of the TPM.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdminState": { "description": "Identifies the admin configured state of the TPM.", "type": "string", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "Firmware Version of the Trusted Platform Module.", "type": "string", "x-omitempty": true }, "Ownership": { "description": "Identifies the ownership information of the TPM.", "type": "string", "readOnly": true, "x-omitempty": true }, "TpmId": { "description": "Enter the ID of the trusted platform module.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Identifies the version of the Trusted Platform Module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Tpm.List": { "title": "List of 'equipment.Tpm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Tpm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Tpm' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Tpm" }, "nullable": true } } } ] }, "equipment.Transceiver.Response": { "description": "The response body of a HTTP GET request for the 'equipment.Transceiver' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'equipment.Transceiver' resources.", "x-one-of-name": "equipment.Transceiver.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/equipment.Transceiver.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "equipment.Transceiver": { "title": "Equipment:Transceiver", "description": "The equipment.Transceiver object represents a pluggable optical or copper transceiver (e.g., SFP, QSFP) installed in a port of a network device like a Fabric Interconnect.\n#### Purpose\nThe Transceiver object is used to inventory the details of a specific transceiver. It captures critical information such as its type, operSpeed, and operState. It is essential for troubleshooting physical layer connectivity issues, verifying compatibility, and managing network port configurations.\n#### Key Concepts\n- **Physical Layer Inventory:** Provides a detailed record of the pluggable module in a network port.\n- **Compatibility and Type:** The type property (e.g., \"QSFP-40G-SR-BD\") is crucial for verifying that a supported transceiver is being used for a given port speed and media type.\n- **Operational Status:** The operState and operStateQual properties provide the current status and the reason for that status (e.g., \"xcvr-absent\", \"sfp-mismatch\"), which is vital for troubleshooting.\n- **Port-Specific:** It is a child of a physical port object (ether.PhysicalPort or fc.PhysicalPort), directly linking it to the port it is installed in.", "x-allOf-name": "equipment.Transceiver", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'equipment.Transceiver', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "equipment.Transceiver" ], "default": "equipment.Transceiver", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "equipment.Transceiver" ], "default": "equipment.Transceiver", "x-enum-as-string": true }, "AggregatePortId": { "description": "Breakout port member in the Fabric Interconnect.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CiscoExtendedIdNumber": { "description": "The cisco extended Id number state of the pluggable SFP.", "type": "string", "x-omitempty": true }, "InterfaceType": { "description": "Interface type of transceiver copper or fiber.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManufacturerPartNumber": { "description": "The manufacturer part number of the pluggable SFP.", "type": "string", "x-omitempty": true }, "ModuleId": { "description": "Fabric extender identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the pluggable transceiver.", "type": "string", "x-omitempty": true }, "OperSpeed": { "description": "Operational speed of the transceiver.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational state of the transceiver.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperStateQual": { "description": "Reason for this transceiver's operational state.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Switch physical port identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "Switch expansion slot module identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the pluggable SFP.", "type": "string", "x-omitempty": true }, "SwitchId": { "description": "Switch Identifier that is local to a cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the transceiver.", "type": "string", "readOnly": true, "x-omitempty": true }, "EtherHostPort": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.HostPort.Relationship", "description": "A reference to a etherHostPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EtherPhysicalPort": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/ether.PhysicalPort.Relationship", "description": "A reference to a etherPhysicalPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FcPhysicalPort": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fc.PhysicalPort.Relationship", "description": "A reference to a fcPhysicalPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "equipment.Transceiver.List": { "title": "List of 'equipment.Transceiver' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'equipment.Transceiver' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'equipment.Transceiver' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Transceiver" }, "nullable": true } } } ] }, "fault.Instance.Response": { "description": "The response body of a HTTP GET request for the 'fault.Instance' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fault.Instance' resources.", "x-one-of-name": "fault.Instance.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fault.Instance.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fault.Instance": { "title": "Fault:Instance", "description": "An endpoint anomaly is represented by this object.", "x-allOf-name": "fault.Instance", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'fault.Instance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fault.Instance" ], "default": "fault.Instance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fault.Instance" ], "default": "fault.Instance", "x-enum-as-string": true }, "Acknowledged": { "description": "The user acknowledgement state of the fault.", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedDn": { "description": "The Distinguished Name of the Managed object which was affected.", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedMoId": { "description": "Managed object Id which was affected.", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedMoType": { "description": "Managed object type which was affected.", "type": "string", "readOnly": true, "x-omitempty": true }, "AncestorMoId": { "description": "Object Id of the parent of the Managed object which was affected.", "type": "string", "readOnly": true, "x-omitempty": true }, "AncestorMoType": { "description": "Object type of the parent of the Managed object which was affected.", "type": "string", "readOnly": true, "x-omitempty": true }, "Code": { "description": "Numerical fault code of the fault found.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreationTime": { "description": "The time of creation of the fault instance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Short summary of the fault found.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastTransitionTime": { "description": "Last transition time of the fault.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumOccurrences": { "description": "The number of times this fault has occured.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OriginalSeverity": { "description": "Current Severity of the fault found.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreviousSeverity": { "description": "The Severity of the fault prior to user update.", "type": "string", "readOnly": true, "x-omitempty": true }, "Rule": { "description": "The rule that is responsible for generation of the fault.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "Severity of the fault found.", "type": "string", "readOnly": true, "x-omitempty": true }, "AffectedMo": { "$ref": "#/components/schemas/inventory.Base.Relationship", "description": "A reference to a inventoryBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "AncestorMo": { "$ref": "#/components/schemas/inventory.Base.Relationship", "description": "A reference to a inventoryBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fault.Instance.List": { "title": "List of 'fault.Instance' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fault.Instance' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fault.Instance' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fault.Instance" }, "nullable": true } } } ] }, "fcpool.Block": { "title": "Fcpool:Block", "description": "Block of WWN identifiers.", "x-allOf-name": "fcpool.Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.Block" ], "default": "fcpool.Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.Block" ], "default": "fcpool.Block", "x-enum-as-string": true }, "From": { "description": "Starting WWN identifier of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. Allowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF. To ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the following WWN prefix; 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-omitempty": true }, "To": { "description": "Ending WWN identifier of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-omitempty": true } } } ] }, "fcpool.FcBlock.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.FcBlock' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.FcBlock' resources.", "x-one-of-name": "fcpool.FcBlock.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.FcBlock.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.FcBlock.Relationship": { "description": "A relationship to the 'fcpool.FcBlock' resource, or the expanded 'fcpool.FcBlock' resource, or the 'null' value.", "x-one-of-name": "fcpool.FcBlock.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.FcBlock" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.FcBlock": { "title": "Fcpool:Fc Block", "description": "A Block object represents a sequential range of WWN (World Wide Name) addresses defined by a start and end address. A pool can contain multiple blocks.\n#### Purpose\nThe block object serves as a fundamental unit within a WWN pool, enabling efficient management and allocation of contiguous network identifiers.\n#### Key Concepts\n- **Range Definition:** Represents a contiguous range of WWN addresses with defined start and end values.\n- **Identifier Type:** Manages WWN-based identifiers used in network fabrics.\n- **Pool Association:** Functions as a core component within WWN pools for structured resource management.\n- **Contiguity:** Ensures sequential and non-overlapping address allocation for optimal utilization.", "x-allOf-name": "fcpool.FcBlock", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlock" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.FcBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.FcBlock" ], "default": "fcpool.FcBlock", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.FcBlock" ], "default": "fcpool.FcBlock", "x-enum-as-string": true }, "IdBlock": { "description": "A block of WWN addresses.", "$ref": "#/components/schemas/fcpool.Block", "x-omitempty": true }, "Pool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to fcpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Reservation.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "fcpool.FcBlock.List": { "title": "List of 'fcpool.FcBlock' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.FcBlock' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.FcBlock' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.FcBlock" }, "nullable": true } } } ] }, "fcpool.Lease.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.Lease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.Lease' resources.", "x-one-of-name": "fcpool.Lease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.Lease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.Lease.Relationship": { "description": "A relationship to the 'fcpool.Lease' resource, or the expanded 'fcpool.Lease' resource, or the 'null' value.", "x-one-of-name": "fcpool.Lease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.Lease" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.Lease": { "title": "Fcpool:Lease", "description": "### Overview\nA Lease object represents a single allocated WWN (World Wide Name) address from a pool or static assignment.\n#### Purpose\nIt maintains the association between the allocated identifier and its consumer, tracking ownership and lifecycle of the WWN address within the system.\n#### Key aspects:\n- **Resource Management:** - Facilitates the allocation of a single WWN address within pools, ensuring efficient allocation.\n- **Integration with Pools:** - Directly interacts with pool objects to manage resource leases and reservations.\n- **Access Control:** - Supports secure management of resource leases, allowing authorized users to execute lease operations.", "x-allOf-name": "fcpool.Lease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.Lease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.Lease" ], "default": "fcpool.Lease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.Lease" ], "default": "fcpool.Lease", "x-enum-as-string": true }, "PoolPurpose": { "description": "Purpose of this WWN pool.", "type": "string", "x-omitempty": true }, "PreferredWwnId": { "description": "The preferred WWN ID address can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that WWN ID address if it is available in the pool. If the specified preferred WWN ID address is not in the range of the pool or if it is already leased or reserved, then the next available WWN ID address from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred WWN ID address property. When the preferred WWN ID address property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration also supported only for dynamic lease requests.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-createOnly": true, "x-omitempty": true }, "Reservation": { "description": "The holder of a reference to reservation Moid and the specific details on lease condition for this reservation. Specified to allocate already reserved identities.", "$ref": "#/components/schemas/fcpool.ReservationReference", "x-createOnly": true, "x-omitempty": true }, "WwnId": { "description": "WWN ID allocated for pool based allocation.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Pool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/fcpool.PoolMember.Relationship", "description": "A reference to a fcpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/fcpool.Universe.Relationship", "description": "A reference to a fcpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fcpool.Lease.List": { "title": "List of 'fcpool.Lease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.Lease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.Lease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Lease" }, "nullable": true } } } ] }, "fcpool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.Pool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.Pool' resources.", "x-one-of-name": "fcpool.Pool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.Pool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.Pool.Relationship": { "description": "A relationship to the 'fcpool.Pool' resource, or the expanded 'fcpool.Pool' resource, or the 'null' value.", "x-one-of-name": "fcpool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.Pool": { "title": "Fcpool:Pool", "description": "The Pool object represents a collection of WWN addresses, that can be allocated to server profiles.\n#### Purpose\nThe Pool object provides a structured approach to managing collections of identifiers, ensuring efficient allocation and management within server profiles and other entities.\n#### Key Concepts\n- **Resource Collection:** Manages a collection of identifiers, facilitating their allocation to various entities within the system.\n- **Dynamic Management** Supports dynamic allocation and reassignment of identifiers based on pool policies and conditions.\n- **Access Control:** Ensures secure management of resources within pools, enabling authorized actions such as creation, update, and deletion.", "x-allOf-name": "fcpool.Pool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.Pool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.Pool" ], "default": "fcpool.Pool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.Pool" ], "default": "fcpool.Pool", "x-enum-as-string": true }, "IdBlocks": { "type": "array", "items": { "description": "Collection of WWN blocks.", "$ref": "#/components/schemas/fcpool.Block", "x-omitempty": true }, "nullable": true }, "PoolPurpose": { "description": "Purpose of this WWN pool.", "type": "string", "x-omitempty": true }, "BlockHeads": { "description": "An array of relationships to fcpoolFcBlock resources.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.FcBlock.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Reservations": { "description": "An array of relationships to fcpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Reservation.Relationship" }, "nullable": true } } } ] }, "fcpool.Pool.List": { "title": "List of 'fcpool.Pool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.Pool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Pool" }, "nullable": true } } } ] }, "fcpool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.PoolMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.PoolMember' resources.", "x-one-of-name": "fcpool.PoolMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.PoolMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.PoolMember.Relationship": { "description": "A relationship to the 'fcpool.PoolMember' resource, or the expanded 'fcpool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "fcpool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.PoolMember": { "title": "Fcpool:Pool Member", "description": "Pool Member object represents a single WWN (Worldwide Name) address within a pool that tracks its state, availability, and allocation.\n#### Purpose\nThe PoolMember object serves as a representation of individual resources within a pool, facilitating their management and allocation. It serves as a bridge between the pool's address inventory and active leases or reservation, maintaining the relationship between the WWN identifier and its current usage status. Each pool member object represents an identity that was reserver or leased and its current allocation state.\n#### Key Concepts\n- **Resource Representation:** Acts as a representation of WWN address within pools and its current state, availability, and allocation.\n- **Access Control:** Ensures secure management and allocation of pool members, supporting authorized access and operations.", "x-allOf-name": "fcpool.PoolMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractIdPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.PoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.PoolMember" ], "default": "fcpool.PoolMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.PoolMember" ], "default": "fcpool.PoolMember", "x-enum-as-string": true }, "WwnId": { "description": "WWN ID of this pool member.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BlockHead": { "$ref": "#/components/schemas/fcpool.FcBlock.Relationship", "description": "A reference to a fcpoolFcBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Peer": { "$ref": "#/components/schemas/fcpool.Lease.Relationship", "description": "A reference to a fcpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/fcpool.Reservation.Relationship", "description": "A reference to a fcpoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fcpool.PoolMember.List": { "title": "List of 'fcpool.PoolMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.PoolMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.PoolMember" }, "nullable": true } } } ] }, "fcpool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.Reservation' resources.", "x-one-of-name": "fcpool.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.Reservation.Relationship": { "description": "A relationship to the 'fcpool.Reservation' resource, or the expanded 'fcpool.Reservation' resource, or the 'null' value.", "x-one-of-name": "fcpool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.Reservation": { "title": "Fcpool:Reservation", "description": "The Reservation object is utilized to hold reserved identity information, managing the allocation of resources within pools.\n#### Purpose\nThe Reservation object serves as a mechanism to manage reserved identities within pools for future allocation, providing a structured approach to resource allocation and reservation management.\n#### Key Concepts\n- **Identity Management:** Facilitates the reservation of WWN identities for future allocation within pools.\n- **Resource Allocation:** Ensures that reserved identities are allocated appropriately, supporting dynamic and static allocation types.\n- **Access Control:** Enables authorized users to manage reservations, maintaining secure and efficient resource management.", "x-allOf-name": "fcpool.Reservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.Reservation" ], "default": "fcpool.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.Reservation" ], "default": "fcpool.Reservation", "x-enum-as-string": true }, "IdPurpose": { "description": "Purpose of this WWN ID. Purpose can be WWPN or WWNN.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Identity": { "description": "WWN ID that needs to be reserved.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-createOnly": true, "x-omitempty": true }, "Block": { "$ref": "#/components/schemas/fcpool.FcBlock.Relationship", "description": "A reference to a fcpoolFcBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Pool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/fcpool.PoolMember.Relationship", "description": "A reference to a fcpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/fcpool.Universe.Relationship", "description": "A reference to a fcpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fcpool.Reservation.List": { "title": "List of 'fcpool.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Reservation" }, "nullable": true } } } ] }, "fcpool.ReservationReference": { "title": "Fcpool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "fcpool.ReservationReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.ReservationReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.ReservationReference" ], "default": "fcpool.ReservationReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.ReservationReference" ], "default": "fcpool.ReservationReference", "x-enum-as-string": true }, "ConsumerName": { "description": "The consumer name for which the reserved fc pool would be used.", "type": "string", "x-omitempty": true }, "ConsumerType": { "description": "The consumer type for which the reserved fc pool would be used.\n* `Vhba` - FC reservation would be used by Vhba.\n* `WWNN` - FC reservation would be used by WWNN.", "type": "string", "enum": [ "Vhba", "WWNN" ], "default": "Vhba", "x-omitempty": true } } } ] }, "fcpool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'fcpool.Universe' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'fcpool.Universe' resources.", "x-one-of-name": "fcpool.Universe.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/fcpool.Universe.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "fcpool.Universe.Relationship": { "description": "A relationship to the 'fcpool.Universe' resource, or the expanded 'fcpool.Universe' resource, or the 'null' value.", "x-one-of-name": "fcpool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/fcpool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "fcpool.Universe": { "title": "Fcpool:Universe", "description": "Universe represents a book keeping container to keep track of all IDs for a given account and pool type.", "x-allOf-name": "fcpool.Universe", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'fcpool.Universe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "fcpool.Universe" ], "default": "fcpool.Universe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "fcpool.Universe" ], "default": "fcpool.Universe", "x-enum-as-string": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "fcpool.Universe.List": { "title": "List of 'fcpool.Universe' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'fcpool.Universe' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'fcpool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/fcpool.Universe" }, "nullable": true } } } ] }, "firmware.BaseDistributable.Relationship": { "description": "A relationship to the 'firmware.BaseDistributable' resource, or the expanded 'firmware.BaseDistributable' resource, or the 'null' value.", "x-one-of-name": "firmware.BaseDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.BaseDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.BaseDistributable": { "title": "Firmware:Base Distributable", "description": "An image distributed by Cisco.", "x-allOf-name": "firmware.BaseDistributable", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.File" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.BaseDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.Distributable", "firmware.DriverDistributable", "firmware.ServerConfigurationUtilityDistributable", "software.ApplianceDistributable", "software.HciBundleDistributable", "software.HciDistributable", "software.HclMeta", "software.HyperflexBundleDistributable", "software.HyperflexDistributable", "software.IksBundleDistributable", "software.SolutionDistributable", "software.UcsdBundleDistributable", "software.UcsdDistributable" ], "x-enum-as-string": true }, "BundleType": { "description": "The bundle type of the image, as published on cisco.com.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComponentMeta": { "type": "array", "items": { "description": "The information about the catalog component.", "$ref": "#/components/schemas/firmware.ComponentMeta", "x-omitempty": true }, "nullable": true }, "Guid": { "description": "The unique identifier for an image in a Cisco repository.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImageType": { "description": "The type of image which the distributable falls into according to the component it can upgrade. For e.g.; Standalone server, Intersight managed server, UCS Managed Fabric Interconnect. The field is used in private appliance mode, where image does not have description populated from CCO.", "type": "string", "x-omitempty": true }, "Mdfid": { "description": "The mdfid of the image provided by cisco.com.", "type": "string", "x-omitempty": true }, "Model": { "description": "The endpoint model for which this firmware image is applicable.", "type": "string", "x-omitempty": true }, "PlatformType": { "description": "The platform type of the image.", "type": "string", "readOnly": true, "x-omitempty": true }, "RecommendedBuild": { "description": "The build which is recommended by Cisco.", "type": "string", "x-omitempty": true }, "ReleaseNotesUrl": { "description": "The url for the release notes of this image.", "type": "string", "x-omitempty": true }, "SoftwareTypeId": { "description": "The software type id provided by cisco.com.", "type": "string", "readOnly": true, "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "The server models for which this image is applicable.", "type": "string", "x-omitempty": true }, "minItems": 1, "nullable": true }, "Vendor": { "description": "The vendor or publisher of this file.", "type": "string", "default": "Cisco", "x-omitempty": true }, "DistributableMetas": { "description": "An array of relationships to firmwareDistributableMeta resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.DistributableMeta.Relationship" }, "nullable": true }, "Release": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Release.Relationship", "description": "A reference to a softwarerepositoryRelease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "firmware.BaseImpact": { "title": "Firmware:Base Impact", "description": "The abstract entity depicting impact on the endpoint during the upgrade operation.", "x-allOf-name": "firmware.BaseImpact", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.BaseImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.ChassisUpgradeImpact", "firmware.ComponentImpact", "firmware.FabricUpgradeImpact", "firmware.ServerUpgradeImpact" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.ChassisUpgradeImpact", "firmware.ComponentImpact", "firmware.FabricUpgradeImpact", "firmware.ServerUpgradeImpact" ], "x-enum-as-string": true }, "ComputationError": { "description": "Details for the error that occurred during the reboot validation analysis.", "type": "string", "x-omitempty": true }, "ComputationStatusDetail": { "description": "The computation status of the estimate operation for a component.\n* `Inprogress` - Upgrade impact calculation is in progress.\n* `Completed` - Upgrade impact calculation is completed.\n* `Unavailable` - Upgrade impact is not available since the image is not present in the Fabric Interconnect.\n* `Failed` - Upgrade impact is not available due to an unknown error.", "type": "string", "enum": [ "Inprogress", "Completed", "Unavailable", "Failed" ], "default": "Inprogress", "x-omitempty": true }, "DomainName": { "description": "The endpoint type or name.", "type": "string", "x-omitempty": true }, "EndPoint": { "description": "A reference to a REST resource, uniquely identified by object type and MOID.", "type": "string", "x-omitempty": true }, "FirmwareVersion": { "description": "The current firmware version of the component.", "type": "string", "x-omitempty": true }, "ImpactType": { "description": "The impact type of the endpoint, whether a reboot is required or not.\n* `NoReboot` - A reboot is not required for the endpoint after upgrade.\n* `Reboot` - A reboot is required to the endpoint after upgrade.", "type": "string", "enum": [ "NoReboot", "Reboot" ], "default": "NoReboot", "x-omitempty": true }, "Model": { "description": "The model details of the component.", "type": "string", "x-omitempty": true }, "TargetFirmwareVersion": { "description": "The target firmware version of the component.", "type": "string", "x-omitempty": true }, "VersionImpact": { "description": "The change of version impact for the endpoint.\n* `None` - No change in version for the component.\n* `Upgrade` - The component will be upgraded.\n* `Downgrade` - The component will be downgraded.", "type": "string", "enum": [ "None", "Upgrade", "Downgrade" ], "default": "None", "x-omitempty": true } } } ] }, "firmware.BiosDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.BiosDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.BiosDescriptor' resources.", "x-one-of-name": "firmware.BiosDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.BiosDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.BiosDescriptor": { "title": "Firmware:Bios Descriptor", "description": "Descriptor to uniquely identify a BIOS.", "x-allOf-name": "firmware.BiosDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.BiosDescriptor.List": { "title": "List of 'firmware.BiosDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.BiosDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.BiosDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.BiosDescriptor" }, "nullable": true } } } ] }, "firmware.BoardControllerDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.BoardControllerDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.BoardControllerDescriptor' resources.", "x-one-of-name": "firmware.BoardControllerDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.BoardControllerDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.BoardControllerDescriptor": { "title": "Firmware:Board Controller Descriptor", "description": "Descriptor to uniquely identify a board controller.", "x-allOf-name": "firmware.BoardControllerDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.BoardControllerDescriptor.List": { "title": "List of 'firmware.BoardControllerDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.BoardControllerDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.BoardControllerDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.BoardControllerDescriptor" }, "nullable": true } } } ] }, "firmware.ChassisUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.ChassisUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.ChassisUpgrade' resources.", "x-one-of-name": "firmware.ChassisUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.ChassisUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.ChassisUpgrade": { "title": "Firmware:Chassis Upgrade", "description": "The ChassisUpgrade object is focused on upgrading firmware for chassis systems, providing a streamlined approach to downloading and applying firmware images from cloud repositories or network shares.\n#### Purpose\nChassisUpgrade ensures chassis systems remain secure and performant through firmware updates. This provides options for both direct download and network share\u2013based upgrades for UCSM devices, and supports certain IMM chassis upgrades via direct download. IMM chassis upgrade updates supported PSU and XFM components when connected to the chassis.\n#### Key Concepts\n- **Chassis System Enhancement:** Designed to optimize chassis firmware upgrades, improving system reliability and efficiency through structured update processes.\n- **Exclusion Options:** Offers the ability to exclude certain components from the upgrade, providing flexibility and customization based on specific upgrade needs.\n- **Integrated Management:** Facilitates comprehensive upgrade operations, from image selection to deployment, ensuring seamless execution and management.\n- **Security and Access Control:** Enforces strict access and compliance measures to protect the upgrade process, maintaining system integrity and security.", "x-allOf-name": "firmware.ChassisUpgrade", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ChassisUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ChassisUpgrade" ], "default": "firmware.ChassisUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ChassisUpgrade" ], "default": "firmware.ChassisUpgrade", "x-enum-as-string": true }, "ChassisName": { "description": "Name of the chassis on which the firmware upgrade operation is performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExcludeComponentList": { "type": "array", "items": { "description": "The components to exclude from the chassis firmware upgrade.\n* `none` - If no component is selected for exclusion.\n* `local-disk` - Component to be excluded is local disk.\n* `psu` - Component to be excluded is PSU.\n* `xfm` - Component to be excluded is XFM.", "type": "string", "enum": [ "none", "local-disk", "psu", "xfm" ], "default": "none", "x-omitempty": true }, "nullable": true }, "XfmUpgradeOption": { "description": "XFM upgrade option Full or Partial Disruption.\n* `none` - If no option is selected for exclusion.\n* `full-shutdown` - PSX Switch in XFM will be upgraded in single action.\n* `partial-shutdown` - PSX Switch in XFM will be upgraded one after other.", "type": "string", "enum": [ "none", "full-shutdown", "partial-shutdown" ], "default": "none", "x-omitempty": true }, "Chassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.ChassisUpgrade.List": { "title": "List of 'firmware.ChassisUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.ChassisUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.ChassisUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.ChassisUpgrade" }, "nullable": true } } } ] }, "firmware.ChassisUpgradeImpact": { "title": "Firmware:Chassis Upgrade Impact", "description": "Impact of the chassis endpoint during the upgrade operation.", "x-allOf-name": "firmware.ChassisUpgradeImpact", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseImpact" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ChassisUpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ChassisUpgradeImpact" ], "default": "firmware.ChassisUpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ChassisUpgradeImpact" ], "default": "firmware.ChassisUpgradeImpact", "x-enum-as-string": true }, "ImpactDetail": { "type": "array", "items": { "description": "List of components that will be impacted during the upgrade.", "$ref": "#/components/schemas/firmware.ComponentImpact", "x-omitempty": true }, "nullable": true }, "ImpactServersDetail": { "type": "array", "items": { "description": "List of components that will be affected during the upgrade.", "$ref": "#/components/schemas/firmware.ServerImpact", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of the chassis that will be affected by the upgrade.", "type": "string", "x-omitempty": true }, "UserLabel": { "description": "Details for the chassis that will be impacted by the upgrade.", "type": "string", "x-omitempty": true } } } ] }, "firmware.CifsServer": { "title": "Firmware:Cifs Server", "description": "An external file repository accessible through the CIFS protocol.", "x-allOf-name": "firmware.CifsServer", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.CifsServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.CifsServer" ], "default": "firmware.CifsServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.CifsServer" ], "default": "firmware.CifsServer", "x-enum-as-string": true }, "FileLocation": { "description": "The location to the image file. The accepted format is IP-or-hostname/folder1/folder2/.../imageFile.", "type": "string", "x-omitempty": true }, "MountOptions": { "description": "Mount option (Authentication Protocol) as configured on the CIFS Server. Example:ntlmv2.\n* `none` - The default authentication protocol is decided by the endpoint.\n* `ntlm` - The external CIFS server is configured with ntlm as the authentication protocol.\n* `ntlmi` - Mount options of CIFS file server is ntlmi.\n* `ntlmv2` - Mount options of CIFS file server is ntlmv2.\n* `ntlmv2i` - Mount options of CIFS file server is ntlmv2i.\n* `ntlmssp` - Mount options of CIFS file server is ntlmssp.\n* `ntlmsspi` - Mount options of CIFS file server is ntlmsspi.", "type": "string", "enum": [ "none", "ntlm", "ntlmi", "ntlmv2", "ntlmv2i", "ntlmssp", "ntlmsspi" ], "default": "none", "x-omitempty": true }, "RemoteFile": { "description": "Filename of the image in the remote share location. Example:ucs-c220m5-huu-3.1.2c.iso.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteIp": { "description": "CIFS Server Hostname or IP Address. For example:CIFS-server-hostname or 10.10.8.7. The remote share server should have network connectivity with the CIMC of the selected devices for a successful upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteShare": { "description": "Directory where the image is stored. Example:share/subfolder.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "firmware.CimcDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.CimcDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.CimcDescriptor' resources.", "x-one-of-name": "firmware.CimcDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.CimcDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.CimcDescriptor": { "title": "Firmware:Cimc Descriptor", "description": "Descriptor to uniquely identify a Cisco IMC.", "x-allOf-name": "firmware.CimcDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.CimcDescriptor.List": { "title": "List of 'firmware.CimcDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.CimcDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.CimcDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.CimcDescriptor" }, "nullable": true } } } ] }, "firmware.ComponentDescriptor": { "title": "Firmware:Component Descriptor", "description": "Descriptor to uniquely identify each component.", "x-allOf-name": "firmware.ComponentDescriptor", "allOf": [ { "$ref": "#/components/schemas/capability.HardwareDescriptor" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ComponentDescriptor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.DriveDescriptor", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PcieDescriptor", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.SasExpanderDescriptor", "firmware.StorageControllerDescriptor" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.BiosDescriptor", "firmware.BoardControllerDescriptor", "firmware.CimcDescriptor", "firmware.DimmDescriptor", "firmware.DriveDescriptor", "firmware.GpuDescriptor", "firmware.HbaDescriptor", "firmware.IomDescriptor", "firmware.MswitchDescriptor", "firmware.NxosDescriptor", "firmware.PcieDescriptor", "firmware.PsuDescriptor", "firmware.PsxDescriptor", "firmware.SasExpanderDescriptor", "firmware.StorageControllerDescriptor" ], "x-enum-as-string": true }, "BrandString": { "description": "The brand string of the endpoint for which this capability information is applicable.", "type": "string", "x-omitempty": true }, "Label": { "description": "The label type for the component.", "type": "string", "x-omitempty": true }, "Revision": { "description": "The revision for the component.", "type": "string", "x-omitempty": true } } } ] }, "firmware.ComponentImpact": { "title": "Firmware:Component Impact", "description": "Impact for the components such as CIMC, BIOS, and disk during the upgrade operation.", "x-allOf-name": "firmware.ComponentImpact", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseImpact" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ComponentImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ComponentImpact" ], "default": "firmware.ComponentImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ComponentImpact" ], "default": "firmware.ComponentImpact", "x-enum-as-string": true }, "Component": { "description": "Impact on the component after the upgrade.\n* `ALL` - This represents all the components.\n* `ALL,HDD` - This represents all the components plus the HDDs.\n* `Drive-U.2` - This represents the U.2 drives that are SFF/LFF drives (mostly all the drives will fall under this category).\n* `Storage` - This represents the storage controller components.\n* `None` - This represents none of the components.\n* `NXOS` - This represents NXOS components.\n* `ESU` - This represents ESU components.\n* `IOM` - This represents IOM components.\n* `PSU` - This represents PSU components.\n* `CIMC` - This represents CIMC components.\n* `BIOS` - This represents BIOS components.\n* `PCIE` - This represents PCIE components.\n* `Drive` - This represents Drive components.\n* `DIMM` - This represents DIMM components.\n* `BoardController` - This represents Board Controller components.\n* `StorageController` - This represents Storage Controller components.\n* `Storage-Sasexpander` - This represents Storage Sas-Expander components.\n* `Storage-U.2` - This represents U2 Storage Controller components.\n* `HBA` - This represents HBA components.\n* `GPU` - This represents GPU components.\n* `SasExpander` - This represents SasExpander components.\n* `MSwitch` - This represents mSwitch components.\n* `CMC` - This represents CMC components.\n* `PSX` - This represents PSX components.", "type": "string", "enum": [ "ALL", "ALL,HDD", "Drive-U.2", "Storage", "None", "NXOS", "ESU", "IOM", "PSU", "CIMC", "BIOS", "PCIE", "Drive", "DIMM", "BoardController", "StorageController", "Storage-Sasexpander", "Storage-U.2", "HBA", "GPU", "SasExpander", "MSwitch", "CMC", "PSX" ], "default": "ALL", "x-omitempty": true } } } ] }, "firmware.ComponentMeta": { "title": "Firmware:Component Meta", "description": "Contains the details for each component in the HSU bundle catalog.", "x-allOf-name": "firmware.ComponentMeta", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ComponentMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ComponentMeta" ], "default": "firmware.ComponentMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ComponentMeta" ], "default": "firmware.ComponentMeta", "x-enum-as-string": true }, "AlternatePackedVersion": { "description": "Certain components have multiple versions packaged in the distributable. For example, the GPU component has multiple versions of the image packaged in the distributable due to a different onboard chip.", "type": "string", "x-omitempty": true }, "ComponentLabel": { "description": "The name of the component in the compressed HSU bundle.", "type": "string", "x-omitempty": true }, "ComponentType": { "description": "The type of component image within the distributable.\n* `ALL` - This represents all the components.\n* `ALL,HDD` - This represents all the components plus the HDDs.\n* `Drive-U.2` - This represents the U.2 drives that are SFF/LFF drives (mostly all the drives will fall under this category).\n* `Storage` - This represents the storage controller components.\n* `None` - This represents none of the components.\n* `NXOS` - This represents NXOS components.\n* `ESU` - This represents ESU components.\n* `IOM` - This represents IOM components.\n* `PSU` - This represents PSU components.\n* `CIMC` - This represents CIMC components.\n* `BIOS` - This represents BIOS components.\n* `PCIE` - This represents PCIE components.\n* `Drive` - This represents Drive components.\n* `DIMM` - This represents DIMM components.\n* `BoardController` - This represents Board Controller components.\n* `StorageController` - This represents Storage Controller components.\n* `Storage-Sasexpander` - This represents Storage Sas-Expander components.\n* `Storage-U.2` - This represents U2 Storage Controller components.\n* `HBA` - This represents HBA components.\n* `GPU` - This represents GPU components.\n* `SasExpander` - This represents SasExpander components.\n* `MSwitch` - This represents mSwitch components.\n* `CMC` - This represents CMC components.\n* `PSX` - This represents PSX components.", "type": "string", "enum": [ "ALL", "ALL,HDD", "Drive-U.2", "Storage", "None", "NXOS", "ESU", "IOM", "PSU", "CIMC", "BIOS", "PCIE", "Drive", "DIMM", "BoardController", "StorageController", "Storage-Sasexpander", "Storage-U.2", "HBA", "GPU", "SasExpander", "MSwitch", "CMC", "PSX" ], "default": "ALL", "x-omitempty": true }, "Description": { "description": "This shows the description of component image within the distributable.", "type": "string", "x-omitempty": true }, "Disruption": { "description": "The type of disruption on each component. For example, host reboot, automatic power cycle, and manual power cycle.\n* `None` - Indicates that the component did not receive a disruption request.\n* `HostReboot` - Indicates that the component received a host reboot request.\n* `EndpointReboot` - Indicates that the component received an end point reboot request.\n* `ManualPowerCycle` - Indicates that the component received a manual power cycle request.\n* `AutomaticPowerCycle` - Indicates that the component received an automatic power cycle request.", "type": "string", "enum": [ "None", "HostReboot", "EndpointReboot", "ManualPowerCycle", "AutomaticPowerCycle" ], "default": "None", "x-omitempty": true }, "ImagePath": { "description": "This shows the path of component image within the distributable.", "type": "string", "x-omitempty": true }, "IsOobSupported": { "description": "If set, the component can be updated through out-of-band management, else, is updated through host service utility boot.", "type": "boolean", "x-omitempty": true }, "Model": { "description": "The model of the component image in the distributable.", "type": "string", "x-omitempty": true }, "OobManageability": { "type": "array", "items": { "description": "The type of operation that can be done through out-of-band management.\n* `None` - The component cannot be updated through out-of-band management. The boot operation is done through the host service utility.\n* `Update` - The component can be updated through out-of-band management.\n* `Inventory` - The component inventory can be updated through out-of-band management.\n* `Activate` - The component can be activated through out-of-band management.\n* `Config` - The component can be configured through out-of-band management.\n* `NA` - Indicates that the out-of-band manageability is not applicable for this component.", "type": "string", "enum": [ "None", "Update", "Inventory", "Activate", "Config", "NA" ], "default": "None", "x-omitempty": true }, "nullable": true }, "PackedVersion": { "description": "The image version of components packaged in the distributable.", "type": "string", "x-omitempty": true }, "RedfishUrl": { "description": "The redfish target for each component.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "The version of component image in the distributable.", "type": "string", "x-omitempty": true } } } ] }, "firmware.DimmDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.DimmDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.DimmDescriptor' resources.", "x-one-of-name": "firmware.DimmDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.DimmDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.DimmDescriptor": { "title": "Firmware:Dimm Descriptor", "description": "Descriptor to uniquely identify a DIMM.", "x-allOf-name": "firmware.DimmDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.DimmDescriptor.List": { "title": "List of 'firmware.DimmDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.DimmDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.DimmDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.DimmDescriptor" }, "nullable": true } } } ] }, "firmware.DirectDownload": { "title": "Firmware:Direct Download", "description": "A specification for downloading the image from Cisco or appliance repository or user provided HTTP file server that hosts the image for firmware upgrade.", "x-allOf-name": "firmware.DirectDownload", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.DirectDownload', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.DirectDownload" ], "default": "firmware.DirectDownload", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.DirectDownload" ], "default": "firmware.DirectDownload", "x-enum-as-string": true }, "HttpServer": { "description": "HTTP Server option when the image source is a local HTTPS server.", "$ref": "#/components/schemas/firmware.HttpServer", "x-omitempty": true }, "ImageSource": { "description": "Source type referring the image to be downloaded from CCO or from a local HTTPS server.\n* `cisco` - Image to be downloaded from Cisco software repository.\n* `localHttp` - Image to be downloaded from a https server.", "type": "string", "enum": [ "cisco", "localHttp" ], "default": "cisco", "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "Password as configured on the local https server.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Upgradeoption": { "description": "Option to control the upgrade, e.g., sd_upgrade_mount_only - download the image into sd and upgrade wait for the server on-next boot.\n* `sd_upgrade_mount_only` - Direct upgrade SD upgrade mount only.\n* `sd_download_only` - Direct upgrade SD download only.\n* `sd_upgrade_only` - Direct upgrade SD upgrade only.\n* `sd_upgrade_full` - Direct upgrade SD upgrade full.\n* `download_only` - Direct upgrade image download only.\n* `upgrade_full` - The upgrade downloads or mounts the image, and reboots immediately for an upgrade.\n* `upgrade_mount_only` - The upgrade downloads or mounts the image. The upgrade happens in next reboot.\n* `chassis_upgrade_full` - Direct upgrade chassis upgrade full.\n* `monitor_only` - Direct upgrade monitor progress only.\n* `validate_only` - Validate whether a component is ready for ugprade.\n* `cancel_only` - Cancel pending upgrade only.", "type": "string", "enum": [ "sd_upgrade_mount_only", "sd_download_only", "sd_upgrade_only", "sd_upgrade_full", "download_only", "upgrade_full", "upgrade_mount_only", "chassis_upgrade_full", "monitor_only", "validate_only", "cancel_only" ], "default": "sd_upgrade_mount_only", "x-omitempty": true }, "Username": { "description": "Username as configured on the local https server.", "type": "string", "x-omitempty": true } } } ] }, "firmware.Distributable.Response": { "description": "The response body of a HTTP GET request for the 'firmware.Distributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.Distributable' resources.", "x-one-of-name": "firmware.Distributable.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.Distributable.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.Distributable.Relationship": { "description": "A relationship to the 'firmware.Distributable' resource, or the expanded 'firmware.Distributable' resource, or the 'null' value.", "x-one-of-name": "firmware.Distributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.Distributable" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.Distributable": { "title": "Firmware:Distributable", "description": "An image distributed by Cisco.", "x-allOf-name": "firmware.Distributable", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.Distributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.Distributable" ], "default": "firmware.Distributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.Distributable" ], "default": "firmware.Distributable", "x-enum-as-string": true }, "FeatureFlags": { "type": "array", "items": { "description": "The list of feature flags required for this image to be visible to a Cisco Intersight account. Each entry is the stringified value of an iam.FeatureType enum (for example \"FirmwareConsolidationEFT\"). If empty or null, the image is visible to all accounts. Otherwise the image is only visible to accounts whose iam.AccountExperience.Features list contains at least one of the listed flags.", "type": "string", "x-omitempty": true }, "nullable": true }, "FileLocation": { "description": "The file location of the distributable.", "type": "string", "x-omitempty": true }, "ImageCategory": { "description": "The category into which the distributable falls into according to the supported platform series. For e.g.; C-Series/B-Series/Infrastructure.", "type": "string", "x-omitempty": true }, "IsBeta": { "description": "Whether this distributable is a beta image and participates in OData filtering so callers can explicitly query beta or non-beta firmware images.", "type": "boolean", "default": false, "x-omitempty": true }, "Origin": { "description": "The source of the distributable. If it has been created by the user or system.\n* `System` - The distributable has been created by the System.\n* `User` - The distributable has been created by the User.", "type": "string", "enum": [ "System", "User" ], "default": "System", "x-omitempty": true }, "Catalog": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Catalog.Relationship", "description": "A reference to a softwarerepositoryCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.Distributable.List": { "title": "List of 'firmware.Distributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.Distributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.Distributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.Distributable" }, "nullable": true } } } ] }, "firmware.DistributableMeta.Response": { "description": "The response body of a HTTP GET request for the 'firmware.DistributableMeta' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.DistributableMeta' resources.", "x-one-of-name": "firmware.DistributableMeta.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.DistributableMeta.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.DistributableMeta.Relationship": { "description": "A relationship to the 'firmware.DistributableMeta' resource, or the expanded 'firmware.DistributableMeta' resource, or the 'null' value.", "x-one-of-name": "firmware.DistributableMeta.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.DistributableMeta" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.DistributableMeta": { "title": "Firmware:Distributable Meta", "description": "Meta information for various firmware images stored in the database. Gives information on the particular category for a product.", "x-allOf-name": "firmware.DistributableMeta", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.DistributableMeta', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.DistributableMeta" ], "default": "firmware.DistributableMeta", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.DistributableMeta" ], "default": "firmware.DistributableMeta", "x-enum-as-string": true }, "BucketName": { "description": "The S3 bucket name where the images are present, if source is external cloud store.", "type": "string", "x-omitempty": true }, "FileType": { "description": "The type of distributable image, example huu, scu, driver, os.\n* `Distributable` - Stores firmware host utility images and fabric images.\n* `DriverDistributable` - Stores driver distributable images.\n* `ServerConfigurationUtilityDistributable` - Stores server configuration utility images.\n* `OperatingSystemFile` - Stores operating system iso images.\n* `HyperflexDistributable` - It stores HyperFlex images.\n* `HciDistributable` - It stores HCI images, such as bootstrap iso images.", "type": "string", "enum": [ "Distributable", "DriverDistributable", "ServerConfigurationUtilityDistributable", "OperatingSystemFile", "HyperflexDistributable", "HciDistributable" ], "default": "Distributable", "x-omitempty": true }, "FromVersion": { "description": "The version from which user can download images from amazon store, if source is external cloud store.", "type": "string", "x-omitempty": true }, "Mdfid": { "description": "The mdfid of the image provided by cisco.com.", "type": "string", "x-omitempty": true }, "SoftwareTypeId": { "description": "The software type id provided by cisco.com.", "type": "string", "x-omitempty": true }, "Source": { "description": "The image can be downloaded from cisco.com or external cloud store.\n* `Cisco` - External repository hosted on cisco.com.\n* `IntersightCloud` - Repository hosted by the Intersight Cloud.\n* `LocalMachine` - The file is available on the local client machine. Used as an upload source type.\n* `NetworkShare` - External repository in the customer datacenter. This will typically be a file server.", "type": "string", "enum": [ "Cisco", "IntersightCloud", "LocalMachine", "NetworkShare" ], "default": "Cisco", "x-omitempty": true }, "SupportedModels": { "type": "array", "items": { "description": "Models which are supported by the corresponding mdfid.", "type": "string", "x-omitempty": true }, "nullable": true }, "ToVersion": { "description": "The version till which user can download images from amazon store, if source is external cloud store.", "type": "string", "x-omitempty": true } } } ] }, "firmware.DistributableMeta.List": { "title": "List of 'firmware.DistributableMeta' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.DistributableMeta' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.DistributableMeta' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.DistributableMeta" }, "nullable": true } } } ] }, "firmware.DriveDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.DriveDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.DriveDescriptor' resources.", "x-one-of-name": "firmware.DriveDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.DriveDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.DriveDescriptor": { "title": "Firmware:Drive Descriptor", "description": "The DriveDescriptor object uniquely identifies a drive within the system. It is a critical part of managing storage components and ensuring compatibility with system operations.\n#### Purpose\nDriveDescriptor provides identification for storage components, supporting software deployment and upgrade processes by ensuring compatibility.\n#### Key Concepts\n- **Storage Identification:** Uniquely identifies storage drives, facilitating accurate mapping and compatibility checks.\n- **Upgrade Management:** Supports software deployment and upgrade processes through precise drive identification.\n- **Catalog Integration:** Links drive descriptors with the Intersight catalog for comprehensive management.\n- **Administration:** Offers tools for managing drive identification and compatibility checks.", "x-allOf-name": "firmware.DriveDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.DriveDescriptor.List": { "title": "List of 'firmware.DriveDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.DriveDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.DriveDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.DriveDescriptor" }, "nullable": true } } } ] }, "firmware.DriverDistributable.Response": { "description": "The response body of a HTTP GET request for the 'firmware.DriverDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.DriverDistributable' resources.", "x-one-of-name": "firmware.DriverDistributable.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.DriverDistributable.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.DriverDistributable": { "title": "Firmware:Driver Distributable", "description": "A device driver image distributed by Cisco.", "x-allOf-name": "firmware.DriverDistributable", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.DriverDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.DriverDistributable" ], "default": "firmware.DriverDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.DriverDistributable" ], "default": "firmware.DriverDistributable", "x-enum-as-string": true }, "Category": { "description": "The device type on which the driver is installable.", "type": "string", "x-omitempty": true }, "Directory": { "description": "Indicates in which directory path this driver will be added.", "type": "string", "x-omitempty": true }, "Osname": { "description": "The operating system name to which this driver is compatible.", "type": "string", "x-omitempty": true }, "Osversion": { "description": "OS Version. It is populated as part of the image import operation.", "type": "string", "x-omitempty": true }, "Catalog": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Catalog.Relationship", "description": "A reference to a softwarerepositoryCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.DriverDistributable.List": { "title": "List of 'firmware.DriverDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.DriverDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.DriverDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.DriverDistributable" }, "nullable": true } } } ] }, "firmware.Eula.Response": { "description": "The response body of a HTTP GET request for the 'firmware.Eula' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.Eula' resources.", "x-one-of-name": "firmware.Eula.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.Eula.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.Eula": { "title": "Firmware:Eula", "description": "End User License Agreement (EULA) acceptance status for an account to access cisco.com and download software.", "x-allOf-name": "firmware.Eula", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.Eula', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.Eula" ], "default": "firmware.Eula", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.Eula" ], "default": "firmware.Eula", "x-enum-as-string": true }, "Accepted": { "description": "Overall acceptance status for the account, both EULA and K9.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Content": { "description": "Acceptance form content provided by cisco.com.", "type": "string", "readOnly": true, "x-omitempty": true }, "EulaAccepted": { "description": "EULA acceptance status for the account.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EulaContent": { "description": "EULA acceptance form content provided by cisco.com.", "type": "string", "readOnly": true, "x-omitempty": true }, "K9Accepted": { "description": "K9 acceptance status for the account.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "K9Content": { "description": "K9 acceptance form content provided by cisco.com.", "type": "string", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.Eula.List": { "title": "List of 'firmware.Eula' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.Eula' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.Eula' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.Eula" }, "nullable": true } } } ] }, "firmware.ExcludeComponentPidListType": { "title": "Firmware:Exclude Component Pid List Type", "description": "The list of components PIDs to be excluded for firmware upgrade.", "x-allOf-name": "firmware.ExcludeComponentPidListType", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ExcludeComponentPidListType', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ExcludeComponentPidListType" ], "default": "firmware.ExcludeComponentPidListType", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ExcludeComponentPidListType" ], "default": "firmware.ExcludeComponentPidListType", "x-enum-as-string": true }, "ExcludeLocalDiskList": { "type": "array", "items": { "description": "The local disk components PIDs to be excluded for server firmware upgrade. All the other local disk components PIDs will be included.", "type": "string", "x-omitempty": true }, "nullable": true }, "ExcludeStorageControllerList": { "type": "array", "items": { "description": "The storage controller components PIDs to be excluded for server firmware upgrade. All the other storage controller components PIDs will be included.", "type": "string", "x-omitempty": true }, "nullable": true } } } ] }, "firmware.FabricUpgradeImpact": { "title": "Firmware:Fabric Upgrade Impact", "description": "Impact for the Fabric Interconnect endpoint during the upgrade operation.", "x-allOf-name": "firmware.FabricUpgradeImpact", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseImpact" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.FabricUpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.FabricUpgradeImpact" ], "default": "firmware.FabricUpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.FabricUpgradeImpact" ], "default": "firmware.FabricUpgradeImpact", "x-enum-as-string": true }, "ImpactDetail": { "type": "array", "items": { "description": "List of components that will be affected during the upgrade.", "$ref": "#/components/schemas/firmware.ComponentImpact", "x-omitempty": true }, "nullable": true }, "Serial": { "description": "Details for the Fabric Interconnect that will be impacted by the upgrade.", "type": "string", "x-omitempty": true } } } ] }, "firmware.FeatureVersionMap": { "title": "Firmware:Feature Version Map", "description": "Maps device firmware version to bundle version. Device firmware is packaged as part of the bundle. Multiple bundle versions may contain identical device firmware.", "x-allOf-name": "firmware.FeatureVersionMap", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.FeatureVersionMap', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.FeatureVersionMap" ], "default": "firmware.FeatureVersionMap", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.FeatureVersionMap" ], "default": "firmware.FeatureVersionMap", "x-enum-as-string": true }, "FeatureName": { "description": "Name of the feature for which the version map is applicable.\n* `Unknown` - Unknown or Invalid feature in the equipment.\n* `ServerRole` - Server Role support for Fabric Interconnect Direct Hardware.\n* `FIAuditd` - AuditD feature support for Fabric Interconnect.\n* `FIAuditdLogMonitorSupport` - AuditD feature Log Monitor support for Fabric Interconnect.", "type": "string", "enum": [ "Unknown", "ServerRole", "FIAuditd", "FIAuditdLogMonitorSupport" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "VersionMap": { "description": "Maps device firmware version to bundle version.", "$ref": "#/components/schemas/firmware.VersionMap", "readOnly": true, "x-omitempty": true } } } ] }, "firmware.FirmwareInventory": { "title": "Firmware:Firmware Inventory", "description": "Firmware inventory for server component.", "x-allOf-name": "firmware.FirmwareInventory", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.FirmwareInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.FirmwareInventory" ], "default": "firmware.FirmwareInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.FirmwareInventory" ], "default": "firmware.FirmwareInventory", "x-enum-as-string": true }, "Category": { "description": "Component category. For example, MRAID is under storage controller, CIMC is under management controller.", "type": "string", "x-omitempty": true }, "Label": { "description": "The name of the component to reflect on UI.", "type": "string", "x-omitempty": true }, "Model": { "description": "Model details of component.", "type": "string", "x-omitempty": true }, "UpdateUri": { "description": "The redfish URI to get the firmware inventory of server components.", "type": "string", "x-omitempty": true }, "Vendor": { "description": "The vendor of the component.", "type": "string", "x-omitempty": true }, "Version": { "description": "The firmware running version on the component.", "type": "string", "x-omitempty": true } } } ] }, "firmware.FirmwareSummary.Response": { "description": "The response body of a HTTP GET request for the 'firmware.FirmwareSummary' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.FirmwareSummary' resources.", "x-one-of-name": "firmware.FirmwareSummary.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.FirmwareSummary.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.FirmwareSummary": { "title": "Firmware:Firmware Summary", "description": "The FirmwareSummary object provides a comprehensive overview of the firmware running on each component within compute physical objects, such as rack or blade servers. It is an integral part of the inventory management system, ensuring that the firmware details are up-to-date and easily accessible for management and policy enforcement.\n#### Purpose\nThe FirmwareSummary object is designed to collect and present detailed information about the firmware versions operating across various server components. It plays a crucial role in maintaining system integrity and performance by enabling administrators to monitor, manage, and enforce firmware policies effectively.\n#### Key Concepts\n- **Inventory Integration:** FirmwareSummary is deeply integrated with the inventory system, reflecting accurate and current firmware data for each managed server component.\n- **Policy Enforcement:** Acts as a foundational element for firmware policy implementation, ensuring that firmware versions align with organizational standards and compliance requirements.\n- **Comprehensive Collection:** Aggregates firmware information across multiple components, providing a holistic view of server firmware status, which aids in decision-making and troubleshooting.\n- **Access and Permissions:** Equipped with robust access controls, allowing authorized personnel to read, update, and manage firmware information securely.", "x-allOf-name": "firmware.FirmwareSummary", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.FirmwareSummary', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.FirmwareSummary" ], "default": "firmware.FirmwareSummary", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.FirmwareSummary" ], "default": "firmware.FirmwareSummary", "x-enum-as-string": true }, "BundleVersion": { "description": "Version details at the bundle level for the each of server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComponentsFwInventory": { "type": "array", "items": { "description": "Collection of running firmware inventory for each component in rack/blade servers.", "$ref": "#/components/schemas/firmware.FirmwareInventory", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkSecureRouter": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship", "description": "A reference to a networkSecureRouter resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.FirmwareSummary.List": { "title": "List of 'firmware.FirmwareSummary' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.FirmwareSummary' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.FirmwareSummary' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.FirmwareSummary" }, "nullable": true } } } ] }, "firmware.GpuDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.GpuDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.GpuDescriptor' resources.", "x-one-of-name": "firmware.GpuDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.GpuDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.GpuDescriptor": { "title": "Firmware:Gpu Descriptor", "description": "Descriptor to uniquely identify a GPU component.", "x-allOf-name": "firmware.GpuDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.GpuDescriptor.List": { "title": "List of 'firmware.GpuDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.GpuDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.GpuDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.GpuDescriptor" }, "nullable": true } } } ] }, "firmware.HbaDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.HbaDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.HbaDescriptor' resources.", "x-one-of-name": "firmware.HbaDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.HbaDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.HbaDescriptor": { "title": "Firmware:Hba Descriptor", "description": "Descriptor to uniquely identify a HBA component.", "x-allOf-name": "firmware.HbaDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.HbaDescriptor.List": { "title": "List of 'firmware.HbaDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.HbaDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.HbaDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.HbaDescriptor" }, "nullable": true } } } ] }, "firmware.HttpServer": { "title": "Firmware:Http Server", "description": "An external HTTP file server.", "x-allOf-name": "firmware.HttpServer", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.HttpServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.HttpServer" ], "default": "firmware.HttpServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.HttpServer" ], "default": "firmware.HttpServer", "x-enum-as-string": true }, "LocationLink": { "description": "HTTP/HTTPS link to the image. Accepted formats HTTP[s]://server-hostname/share/image or HTTP[s]://serverip/share/image. For a successful upgrade, the remote share server must have network connectivity with the CIMC of the selected devices.", "type": "string", "x-omitempty": true }, "MountOptions": { "description": "Mount option as configured on the HTTP server. Empty if nothing is configured.", "type": "string", "x-omitempty": true } } } ] }, "firmware.IomDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.IomDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.IomDescriptor' resources.", "x-one-of-name": "firmware.IomDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.IomDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.IomDescriptor": { "title": "Firmware:Iom Descriptor", "description": "Descriptor to uniquely identify a IOM component.", "x-allOf-name": "firmware.IomDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.IomDescriptor.List": { "title": "List of 'firmware.IomDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.IomDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.IomDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.IomDescriptor" }, "nullable": true } } } ] }, "firmware.ModelBundleVersion": { "title": "Firmware:Model Bundle Version", "description": "Model-version combination for the firmware upgrade.", "x-allOf-name": "firmware.ModelBundleVersion", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ModelBundleVersion', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ModelBundleVersion" ], "default": "firmware.ModelBundleVersion", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ModelBundleVersion" ], "default": "firmware.ModelBundleVersion", "x-enum-as-string": true }, "BundleVersion": { "description": "The bundle version to which the server will be upgraded.", "type": "string", "x-omitempty": true }, "ModelFamily": { "description": "The server family that will be impacted by this upgrade.\n* `UCSC-C220-M5` - The upgrade on all C220-M5 servers claimed in setup.\n* `UCSC-C220-M4` - The upgrade on all C220-M4 servers claimed in setup.\n* `UCSC-C240-M4` - The upgrade on all C240-M4 servers claimed in setup.\n* `UCSC-C460-M4` - The upgrade on all C460-M4 servers claimed in setup.\n* `UCSC-C240-M5` - The upgrade on all C240-M5 servers claimed in setup.\n* `UCSC-C480-M5` - The upgrade on all C480-M5 servers claimed in setup.\n* `UCSB-B200-M5` - The upgrade on all B200-M5 servers claimed in setup.\n* `UCSB-B480-M5` - The upgrade on all B480-M5 servers claimed in setup.\n* `UCSC-C220-M6` - The upgrade on all C220-M6 servers claimed in setup.\n* `UCSC-C240-M6` - The upgrade on all C240-M6 servers claimed in setup.\n* `UCSC-C225-M6` - The upgrade on all C225-M6 servers claimed in setup.\n* `UCSC-C245-M6` - The upgrade on all C245-M6 servers claimed in setup.\n* `UCSB-B200-M6` - The upgrade on all B200-M6 servers claimed in setup.\n* `UCSX-210C-M6` - The upgrade on all 210C-M6 servers claimed in setup.\n* `UCSX-210C-M7` - The upgrade on all 210C-M7 servers claimed in setup.\n* `UCSC-C220-M7` - The upgrade on all C220-M7 servers claimed in setup.\n* `UCSC-C240-M7` - The upgrade on all C240-M7 servers claimed in setup.\n* `UCSC-C125` - The upgrade on all C125 servers claimed in setup.\n* `UCSX-410C-M7` - The upgrade on all 410C-M7 servers claimed in setup.\n* `UCSC-C245-M8` - The upgrade on all UCSC-C245-M8 servers claimed in setup.\n* `UCSC-C225-M8` - The upgrade on all UCSC-C225-M8 servers claimed in setup.\n* `UCSX-215C-M8` - The upgrade on all UCSX-215C-M8 servers claimed in setup.\n* `UCSX-210C-M8` - The upgrade on all UCSX-210C-M8 servers claimed in setup.\n* `UCSX-410C-M8` - The upgrade on all UCSX-410C-M8 servers claimed in setup.\n* `UCSXE-130C-M8` - The upgrade on all UCSXE-130C-M8 servers claimed in setup.\n* `UCSXE-150C-M8` - The upgrade on all UCSXE-150C-M8 servers claimed in setup.\n* `UCSC-C220-M8` - The upgrade on all UCSC-C220-M8 servers claimed in setup.\n* `UCSC-C240-M8` - The upgrade on all UCSC-C240-M8 servers claimed in setup.\n* `CAI-845A-M8` - The upgrade on all CAI-845A-M8 servers claimed in setup.", "type": "string", "enum": [ "UCSC-C220-M5", "UCSC-C220-M4", "UCSC-C240-M4", "UCSC-C460-M4", "UCSC-C240-M5", "UCSC-C480-M5", "UCSB-B200-M5", "UCSB-B480-M5", "UCSC-C220-M6", "UCSC-C240-M6", "UCSC-C225-M6", "UCSC-C245-M6", "UCSB-B200-M6", "UCSX-210C-M6", "UCSX-210C-M7", "UCSC-C220-M7", "UCSC-C240-M7", "UCSC-C125", "UCSX-410C-M7", "UCSC-C245-M8", "UCSC-C225-M8", "UCSX-215C-M8", "UCSX-210C-M8", "UCSX-410C-M8", "UCSXE-130C-M8", "UCSXE-150C-M8", "UCSC-C220-M8", "UCSC-C240-M8", "CAI-845A-M8" ], "default": "UCSC-C220-M5", "x-omitempty": true } } } ] }, "firmware.MswitchDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.MswitchDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.MswitchDescriptor' resources.", "x-one-of-name": "firmware.MswitchDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.MswitchDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.MswitchDescriptor": { "title": "Firmware:Mswitch Descriptor", "description": "Descriptor to uniquely identify a mSwitch component.", "x-allOf-name": "firmware.MswitchDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.MswitchDescriptor.List": { "title": "List of 'firmware.MswitchDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.MswitchDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.MswitchDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.MswitchDescriptor" }, "nullable": true } } } ] }, "firmware.NetworkShare": { "title": "Firmware:Network Share", "description": "Firmware upgrade where the image is located in remote shared machine.", "x-allOf-name": "firmware.NetworkShare", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.NetworkShare', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.NetworkShare" ], "default": "firmware.NetworkShare", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.NetworkShare" ], "default": "firmware.NetworkShare", "x-enum-as-string": true }, "CifsServer": { "description": "CIFS file server option for network share upgrade.", "$ref": "#/components/schemas/firmware.CifsServer", "x-omitempty": true }, "HttpServer": { "description": "HTTP (for WWW) file server option for network share upgrade.", "$ref": "#/components/schemas/firmware.HttpServer", "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "MapType": { "description": "File server protocols such as CIFS, NFS, WWW for HTTP (S) that hosts the image.\n* `nfs` - File server protocol used is NFS.\n* `cifs` - File server protocol used is CIFS.\n* `www` - File server protocol used is WWW.", "type": "string", "enum": [ "nfs", "cifs", "www" ], "default": "nfs", "x-omitempty": true }, "NfsServer": { "description": "NFS file server option for network share upgrade.", "$ref": "#/components/schemas/firmware.NfsServer", "x-omitempty": true }, "Password": { "description": "Password as configured on the file server.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Upgradeoption": { "description": "Option to control the upgrade operation. Some examples, 1) nw_upgrade_mount_only - mount the image from a file server and run the upgrade on the next server boot and 2) nw_upgrade_full - mount the image and immediately run the upgrade.\n* `nw_upgrade_full` - Network upgrade option for full upgrade.\n* `nw_upgrade_mount_only` - Network upgrade mount only.", "type": "string", "enum": [ "nw_upgrade_full", "nw_upgrade_mount_only" ], "default": "nw_upgrade_full", "x-omitempty": true }, "Username": { "description": "Username as configured on the file server.", "type": "string", "x-omitempty": true } } } ] }, "firmware.NfsServer": { "title": "Firmware:Nfs Server", "description": "Network share file server.", "x-allOf-name": "firmware.NfsServer", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.NfsServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.NfsServer" ], "default": "firmware.NfsServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.NfsServer" ], "default": "firmware.NfsServer", "x-enum-as-string": true }, "FileLocation": { "description": "The location to the image file. The accepted format is IP-or-hostname/folder1/folder2/.../imageFile.", "type": "string", "x-omitempty": true }, "MountOptions": { "description": "Mount option as configured on the NFS Server. For example:nolock.", "type": "string", "x-omitempty": true }, "RemoteFile": { "description": "Filename of the image in the remote share location. For example:ucs-c220m5-huu-3.1.2c.iso.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteIp": { "description": "NFS Server Hostname or IP Address. For example:NFS-server-hostname or 10.10.8.7. The remote share server should have network connectivity with the CIMC of the selected devices for a successful upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemoteShare": { "description": "Directory where the image is stored. For example:/share/subfolder.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "firmware.NxosDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.NxosDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.NxosDescriptor' resources.", "x-one-of-name": "firmware.NxosDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.NxosDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.NxosDescriptor": { "title": "Firmware:Nxos Descriptor", "description": "Descriptor to uniquely identify a Fabric interconnect.", "x-allOf-name": "firmware.NxosDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.NxosDescriptor.List": { "title": "List of 'firmware.NxosDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.NxosDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.NxosDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.NxosDescriptor" }, "nullable": true } } } ] }, "firmware.PciNodeUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.PciNodeUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.PciNodeUpgrade' resources.", "x-one-of-name": "firmware.PciNodeUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.PciNodeUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.PciNodeUpgrade": { "title": "Firmware:Pci Node Upgrade", "description": "Firmware upgrade operation for PciNode that downloads the image located at Cisco/appliance/user provided HTTP repository or uses the image from a network share and upgrade. Direct download is used for upgrade that uses the image from a Cisco repository or an appliance repository.", "x-allOf-name": "firmware.PciNodeUpgrade", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.PciNodeUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.PciNodeUpgrade" ], "default": "firmware.PciNodeUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.PciNodeUpgrade" ], "default": "firmware.PciNodeUpgrade", "x-enum-as-string": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.PciNodeUpgrade.List": { "title": "List of 'firmware.PciNodeUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.PciNodeUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.PciNodeUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.PciNodeUpgrade" }, "nullable": true } } } ] }, "firmware.PcieDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.PcieDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.PcieDescriptor' resources.", "x-one-of-name": "firmware.PcieDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.PcieDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.PcieDescriptor": { "title": "Firmware:Pcie Descriptor", "description": "Descriptor to uniquely identify a PCIE component.", "x-allOf-name": "firmware.PcieDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.PcieDescriptor.List": { "title": "List of 'firmware.PcieDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.PcieDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.PcieDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.PcieDescriptor" }, "nullable": true } } } ] }, "firmware.Policy.Response": { "description": "The response body of a HTTP GET request for the 'firmware.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.Policy' resources.", "x-one-of-name": "firmware.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.Policy": { "title": "Firmware", "description": "Firmware policy on the endpoint.", "x-allOf-name": "firmware.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.Policy" ], "default": "firmware.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.Policy" ], "default": "firmware.Policy", "x-enum-as-string": true }, "ExcludeComponentList": { "type": "array", "items": { "description": "The components to be excluded in the server upgrade via policy.\n* `none` - If no component is selected for exclusion.\n* `local-disk` - Component to be excluded is local disk.\n* `drives-except-boot-drives` - The components to be excluded are all drives except the boot drives.\n* `storage-controller` - Component to be excluded is storage controller.\n* `storage-sasexpander` - Component to be excluded is storage sas-expander.\n* `storage-u2` - Component to be excluded is U2 storage controller.", "type": "string", "enum": [ "none", "local-disk", "drives-except-boot-drives", "storage-controller", "storage-sasexpander", "storage-u2" ], "default": "none", "x-omitempty": true }, "nullable": true }, "ModelBundleCombo": { "type": "array", "items": { "description": "The target bundle version and model family which the server will be upgraded to.", "$ref": "#/components/schemas/firmware.ModelBundleVersion", "x-omitempty": true }, "nullable": true }, "TargetPlatform": { "description": "The target platform on which the policy to be applied. Either standalone or connected.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "firmware.Policy.List": { "title": "List of 'firmware.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.Policy" }, "nullable": true } } } ] }, "firmware.PsuDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.PsuDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.PsuDescriptor' resources.", "x-one-of-name": "firmware.PsuDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.PsuDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.PsuDescriptor": { "title": "Firmware:Psu Descriptor", "description": "Descriptor to uniquely identify a PSU component.", "x-allOf-name": "firmware.PsuDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.PsuDescriptor.List": { "title": "List of 'firmware.PsuDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.PsuDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.PsuDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.PsuDescriptor" }, "nullable": true } } } ] }, "firmware.PsxDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.PsxDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.PsxDescriptor' resources.", "x-one-of-name": "firmware.PsxDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.PsxDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.PsxDescriptor": { "title": "Firmware:Psx Descriptor", "description": "Descriptor to uniquely identify a PSX component.", "x-allOf-name": "firmware.PsxDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.PsxDescriptor.List": { "title": "List of 'firmware.PsxDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.PsxDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.PsxDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.PsxDescriptor" }, "nullable": true } } } ] }, "firmware.RunningFirmware.Response": { "description": "The response body of a HTTP GET request for the 'firmware.RunningFirmware' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.RunningFirmware' resources.", "x-one-of-name": "firmware.RunningFirmware.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.RunningFirmware.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.RunningFirmware.Relationship": { "description": "A relationship to the 'firmware.RunningFirmware' resource, or the expanded 'firmware.RunningFirmware' resource, or the 'null' value.", "x-one-of-name": "firmware.RunningFirmware.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.RunningFirmware" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.RunningFirmware": { "title": "Firmware:Running Firmware", "description": "Running Firmware on an endpoint.", "x-allOf-name": "firmware.RunningFirmware", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.RunningFirmware', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.RunningFirmware" ], "default": "firmware.RunningFirmware", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.RunningFirmware" ], "default": "firmware.RunningFirmware", "x-enum-as-string": true }, "Component": { "description": "Kind of the firmware - boot-booloader/system/kernel.", "type": "string", "readOnly": true, "x-omitempty": true }, "PackageVersion": { "description": "Bundle version which the firmware belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the firmware.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the firmware.", "type": "string", "readOnly": true, "x-omitempty": true }, "BiosUnit": { "$ref": "#/components/schemas/bios.Unit.Relationship", "description": "A reference to a biosUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentEnclosureElement": { "$ref": "#/components/schemas/equipment.EnclosureElement.Relationship", "description": "A reference to a equipmentEnclosureElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentPsu": { "$ref": "#/components/schemas/equipment.Psu.Relationship", "description": "A reference to a equipmentPsu resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GraphicsCard": { "$ref": "#/components/schemas/graphics.Card.Relationship", "description": "A reference to a graphicsCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ManagementController": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElements": { "description": "An array of relationships to networkElement resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship" }, "nullable": true }, "PciSwitch": { "$ref": "#/components/schemas/pci.Switch.Relationship", "description": "A reference to a pciSwitch resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexFlashController": { "$ref": "#/components/schemas/storage.FlexFlashController.Relationship", "description": "A reference to a storageFlexFlashController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StoragePhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.RunningFirmware.List": { "title": "List of 'firmware.RunningFirmware' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.RunningFirmware' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.RunningFirmware' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware" }, "nullable": true } } } ] }, "firmware.SasExpanderDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.SasExpanderDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.SasExpanderDescriptor' resources.", "x-one-of-name": "firmware.SasExpanderDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.SasExpanderDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.SasExpanderDescriptor": { "title": "Firmware:Sas Expander Descriptor", "description": "Descriptor to uniquely identify a SasExpandar component.", "x-allOf-name": "firmware.SasExpanderDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.SasExpanderDescriptor.List": { "title": "List of 'firmware.SasExpanderDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.SasExpanderDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.SasExpanderDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.SasExpanderDescriptor" }, "nullable": true } } } ] }, "firmware.SecureRouterUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.SecureRouterUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.SecureRouterUpgrade' resources.", "x-one-of-name": "firmware.SecureRouterUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.SecureRouterUpgrade": { "title": "Firmware:Secure Router Upgrade", "description": "Firmware upgrade operation for Secure Router that downloads the image located at Cisco/appliance/user provided HTTP repository or uses the image from a network share and upgrade. Direct download is used for upgrade that uses the image from a Cisco repository or an appliance repository.", "x-allOf-name": "firmware.SecureRouterUpgrade", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.SecureRouterUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.SecureRouterUpgrade" ], "default": "firmware.SecureRouterUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.SecureRouterUpgrade" ], "default": "firmware.SecureRouterUpgrade", "x-enum-as-string": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkSecureRouter": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship", "description": "A reference to a networkSecureRouter resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.SecureRouterUpgrade.List": { "title": "List of 'firmware.SecureRouterUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.SecureRouterUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.SecureRouterUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.SecureRouterUpgrade" }, "nullable": true } } } ] }, "firmware.ServerConfigurationUtilityDistributable.Response": { "description": "The response body of a HTTP GET request for the 'firmware.ServerConfigurationUtilityDistributable' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.ServerConfigurationUtilityDistributable' resources.", "x-one-of-name": "firmware.ServerConfigurationUtilityDistributable.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.ServerConfigurationUtilityDistributable.Relationship": { "description": "A relationship to the 'firmware.ServerConfigurationUtilityDistributable' resource, or the expanded 'firmware.ServerConfigurationUtilityDistributable' resource, or the 'null' value.", "x-one-of-name": "firmware.ServerConfigurationUtilityDistributable.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.ServerConfigurationUtilityDistributable": { "title": "Server Configuration Utility", "description": "A server configuration utility image distributed by Cisco.", "x-allOf-name": "firmware.ServerConfigurationUtilityDistributable", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseDistributable" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ServerConfigurationUtilityDistributable', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ServerConfigurationUtilityDistributable" ], "default": "firmware.ServerConfigurationUtilityDistributable", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ServerConfigurationUtilityDistributable" ], "default": "firmware.ServerConfigurationUtilityDistributable", "x-enum-as-string": true }, "Catalog": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Catalog.Relationship", "description": "A reference to a softwarerepositoryCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.ServerConfigurationUtilityDistributable.List": { "title": "List of 'firmware.ServerConfigurationUtilityDistributable' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.ServerConfigurationUtilityDistributable' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.ServerConfigurationUtilityDistributable' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable" }, "nullable": true } } } ] }, "firmware.ServerImpact": { "title": "Firmware:Server Impact", "description": "Impact for the components such as CIMC, BIOS, and disk during the upgrade operation.", "x-allOf-name": "firmware.ServerImpact", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ServerImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ServerImpact" ], "default": "firmware.ServerImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ServerImpact" ], "default": "firmware.ServerImpact", "x-enum-as-string": true }, "DisplayName": { "description": "Display name of the server impacted by the upgrade.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the server impacted by the upgrade.", "type": "string", "x-omitempty": true }, "RebootAt": { "description": "The reboot impact for the server endpoint during the upgrade operation.\n* `Phase1` - Server will be rebooted in the first phase of upgrade.\n* `Phase2` - Server will be rebooted in the second phase of upgrade.", "type": "string", "enum": [ "Phase1", "Phase2" ], "default": "Phase1", "x-omitempty": true }, "Server": { "description": "The server on which this upgrade operation is performed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true } } } ] }, "firmware.ServerUpgradeImpact": { "title": "Firmware:Server Upgrade Impact", "description": "Impact of the server endpoint during the upgrade operation.", "x-allOf-name": "firmware.ServerUpgradeImpact", "allOf": [ { "$ref": "#/components/schemas/firmware.BaseImpact" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.ServerUpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.ServerUpgradeImpact" ], "default": "firmware.ServerUpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.ServerUpgradeImpact" ], "default": "firmware.ServerUpgradeImpact", "x-enum-as-string": true }, "ImpactDetail": { "type": "array", "items": { "description": "List of components that will be impacted during upgrade.", "$ref": "#/components/schemas/firmware.ComponentImpact", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of the server impacted by the upgrade.", "type": "string", "x-omitempty": true }, "UserLabel": { "description": "Details about the server which will be impacted by the upgrade.", "type": "string", "x-omitempty": true } } } ] }, "firmware.StorageControllerDescriptor.Response": { "description": "The response body of a HTTP GET request for the 'firmware.StorageControllerDescriptor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.StorageControllerDescriptor' resources.", "x-one-of-name": "firmware.StorageControllerDescriptor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.StorageControllerDescriptor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.StorageControllerDescriptor": { "title": "Firmware:Storage Controller Descriptor", "description": "The StorageControllerDescriptor object uniquely identifies a storage controller within the system. It is essential for managing storage components and ensuring compatibility with system operations.\n#### Purpose\nStorageControllerDescriptor provides identification for storage controllers, supporting software deployment and upgrade processes by ensuring compatibility.\n#### Key Concepts\n- **Storage Management:** Uniquely identifies storage controllers, facilitating accurate mapping and compatibility checks.\n- **Upgrade Support:** Supports software deployment and upgrade processes through precise controller identification.\n- **Catalog Integration:** Links controller descriptors with the Intersight catalog for comprehensive management.\n- **Administration:** Offers tools for managing controller identification and compatibility checks.", "x-allOf-name": "firmware.StorageControllerDescriptor", "allOf": [ { "$ref": "#/components/schemas/firmware.ComponentDescriptor" } ] }, "firmware.StorageControllerDescriptor.List": { "title": "List of 'firmware.StorageControllerDescriptor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.StorageControllerDescriptor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.StorageControllerDescriptor' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.StorageControllerDescriptor" }, "nullable": true } } } ] }, "firmware.SwitchUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.SwitchUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.SwitchUpgrade' resources.", "x-one-of-name": "firmware.SwitchUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.SwitchUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.SwitchUpgrade": { "title": "Firmware:Switch Upgrade", "description": "The SwitchUpgrade object is designed for upgrading firmware on Fabric Interconnects, streamlining the process of downloading and applying firmware images from cloud repositories or network shares.\n#### Purpose\nSwitchUpgrade simplifies the firmware upgrade process for Fabric Interconnects, enhancing network performance and security by facilitating timely updates. This provides options for both direct download and network share-based upgrades for UCSM devices. IMM Fabric Interconnect supports direct download.\n#### Key Concepts\n- **Fabric Interconnect Optimization:** Tailored to address the specific needs of Fabric Interconnects, ensuring efficient and effective firmware upgrades.\n- **Evacuation Management:** Includes features to manage fabric evacuation during upgrades, enhancing operational continuity and minimizing disruptions.\n- **Flexible Deployment:** Supports both direct download from Cisco sources and network share-based upgrades, catering to varied infrastructure configurations.\n- **Security and Compliance:** Implements rigorous access and licensing controls, ensuring upgrades are performed securely and in compliance with organizational policies.", "x-allOf-name": "firmware.SwitchUpgrade", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.SwitchUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.SwitchUpgrade" ], "default": "firmware.SwitchUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.SwitchUpgrade" ], "default": "firmware.SwitchUpgrade", "x-enum-as-string": true }, "EnableFabricEvacuation": { "description": "The flag to enable or disable fabric evacuation during the switch firmware upgrade. In case of IMM, it is mandatory to have the Fabric Interconnects associated with domain profile for fabric evacuation to happen.", "type": "boolean", "default": true, "x-omitempty": true }, "EnablePdbFpgaUpgrade": { "description": "The flag to enable or disable firmware upgrade functionality for the PDB FPGA.", "type": "boolean", "default": false, "x-omitempty": true }, "EnablePsuUpgrade": { "description": "The flag to enable or disable firmware upgrade functionality for the Power Supply Unit (PSU).", "type": "boolean", "default": false, "x-omitempty": true }, "SkipWaitForIoPathConnectivity": { "description": "The flag to enable or disable the option to wait for IO paths connectivity during the switch firmware upgrade.", "type": "boolean", "default": false, "x-omitempty": true }, "SwitchName": { "description": "Name of the Fabric Interconnect on which the firmware upgrade operation is performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "WaitTimeOut": { "description": "Specifies a timeout period, in minutes, before the firmware upgrade begins. The valid range is -1 to 1000. A value of -1 requires manual user acknowledgment to proceed, 0 starts the upgrade immediately, and values from 1 to 1000 wait the specified number of minutes before starting. The upgrade will automatically begin once the timeout expires, but it can also be initiated manually at any time before the timeout ends. If no value is specified, manual user acknowledgment is required, equivalent to -1.", "type": "integer", "format": "int64", "default": -1, "minimum": -1, "maximum": 1000, "x-createOnly": true, "x-omitempty": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElements": { "description": "An array of relationships to networkElement resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "firmware.SwitchUpgrade.List": { "title": "List of 'firmware.SwitchUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.SwitchUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.SwitchUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.SwitchUpgrade" }, "nullable": true } } } ] }, "firmware.UnsupportedVersionUpgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.UnsupportedVersionUpgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.UnsupportedVersionUpgrade' resources.", "x-one-of-name": "firmware.UnsupportedVersionUpgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.UnsupportedVersionUpgrade": { "title": "Upgrade equipment with unsupported firmware", "description": "This represents an operation managed object used for upgrading equipment that cannot be discovered due to unsupported firmware. Currently, it only supports blade upgrades.", "x-allOf-name": "firmware.UnsupportedVersionUpgrade", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.DownloadStatus" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UnsupportedVersionUpgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.UnsupportedVersionUpgrade" ], "default": "firmware.UnsupportedVersionUpgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.UnsupportedVersionUpgrade" ], "default": "firmware.UnsupportedVersionUpgrade", "x-enum-as-string": true }, "UpgradeStatus": { "description": "Workflow status of firmware upgrade.\n* `None` - Upgrade status is none when upgrade is in progress.\n* `Completed` - Upgrade completed successfully.\n* `Failed` - Upgrade status is failed when upgrade has failed.", "type": "string", "enum": [ "None", "Completed", "Failed" ], "default": "None", "x-omitempty": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Distributable": { "$ref": "#/components/schemas/firmware.Distributable.Relationship", "description": "A reference to a firmwareDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PhysicalIdentity": { "$ref": "#/components/schemas/equipment.PhysicalIdentity.Relationship", "description": "A reference to a equipmentPhysicalIdentity resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.UnsupportedVersionUpgrade.List": { "title": "List of 'firmware.UnsupportedVersionUpgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.UnsupportedVersionUpgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.UnsupportedVersionUpgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.UnsupportedVersionUpgrade" }, "nullable": true } } } ] }, "firmware.Upgrade.Response": { "description": "The response body of a HTTP GET request for the 'firmware.Upgrade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.Upgrade' resources.", "x-one-of-name": "firmware.Upgrade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.Upgrade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.Upgrade": { "title": "Firmware:Upgrade", "description": "The Upgrade object facilitates the firmware upgrade process for rack and blade servers, providing a structured approach to downloading and applying firmware images from various sources, including cloud repositories and network shares.\n#### Purpose\nThe Upgrade object is central to orchestrating firmware upgrades, offering a standardized method to enhance server functionality and security through timely firmware updates. It supports both direct download and network share upgrade methods.\n#### Key Concepts\n- **Flexible Upgrade Options:** Supports direct download from Cisco repositories and network share-based upgrades, accommodating diverse infrastructure setups and preferences.\n- **Policy Integration:** Seamlessly interacts with firmware policies, ensuring compliance and alignment with organizational upgrade strategies.\n- **Comprehensive Management:** Facilitates the entire upgrade lifecycle, from image selection and download to installation and verification, ensuring a reliable upgrade experience.\n- **Secure and Controlled:** Enforces strict access controls and licensing requirements to safeguard the upgrade process, maintaining system security and compliance.", "x-allOf-name": "firmware.Upgrade", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.Upgrade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.Upgrade" ], "default": "firmware.Upgrade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.Upgrade" ], "default": "firmware.Upgrade", "x-enum-as-string": true }, "ExcludeComponentList": { "type": "array", "items": { "description": "The components to be excluded for server firmware upgrade.\n* `none` - If no component is selected for exclusion.\n* `local-disk` - Component to be excluded is local disk.\n* `drives-except-boot-drives` - The components to be excluded are all drives except the boot drives.\n* `storage-controller` - Component to be excluded is storage controller.\n* `storage-sasexpander` - Component to be excluded is storage sas-expander.\n* `storage-u2` - Component to be excluded is U2 storage controller.", "type": "string", "enum": [ "none", "local-disk", "drives-except-boot-drives", "storage-controller", "storage-sasexpander", "storage-u2" ], "default": "none", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "ExcludeComponentPidList": { "description": "The components PIDs which are to be excluded for server firmware upgrade.", "$ref": "#/components/schemas/firmware.ExcludeComponentPidListType", "x-createOnly": true, "x-omitempty": true }, "ServerName": { "description": "Name of the server on which the firmware upgrade operation is performed.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpgradeTriggerMethod": { "description": "The source that triggered the upgrade. Either via profile or traditional way.\n* `none` - Upgrade is invoked within the service.\n* `profileTrigger` - Upgrade is invoked from a profile deployment.", "type": "string", "enum": [ "none", "profileTrigger" ], "default": "none", "x-omitempty": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "firmware.Upgrade.List": { "title": "List of 'firmware.Upgrade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.Upgrade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.Upgrade' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.Upgrade" }, "nullable": true } } } ] }, "firmware.UpgradeBase.Relationship": { "description": "A relationship to the 'firmware.UpgradeBase' resource, or the expanded 'firmware.UpgradeBase' resource, or the 'null' value.", "x-one-of-name": "firmware.UpgradeBase.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.UpgradeBase" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.UpgradeBase": { "title": "Firmware:Upgrade Base", "description": "Firmware upgrade operation that downloads the image from Cisco/appliance/user provided HTTP repository or use the image from a network share and upgrade. The direct download is used for upgrade to use the image from Cisco repository or appliance repository. The network share is used for upgrade to use the image from a network share in user data center.", "x-allOf-name": "firmware.UpgradeBase", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.ChassisUpgrade", "firmware.PciNodeUpgrade", "firmware.SecureRouterUpgrade", "firmware.SwitchUpgrade", "firmware.Upgrade" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.ChassisUpgrade", "firmware.PciNodeUpgrade", "firmware.SecureRouterUpgrade", "firmware.SwitchUpgrade", "firmware.Upgrade" ], "x-enum-as-string": true }, "DirectDownload": { "description": "Direct download options in case the upgradeType is direct download based upgrade.", "$ref": "#/components/schemas/firmware.DirectDownload", "x-createOnly": true, "x-omitempty": true }, "FileServer": { "description": "Location of the image in user software repository.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.FileServer", "x-createOnly": true, "x-omitempty": true }, "NetworkShare": { "description": "Deprecated (Use 'fileServer' property). Network share options in case of the upgradeType is network share based upgrade.", "$ref": "#/components/schemas/firmware.NetworkShare", "x-createOnly": true, "x-omitempty": true }, "SkipEstimateImpact": { "description": "User has the option to skip the estimate impact calculation.", "type": "boolean", "x-createOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the upgrade operation.\n* `NONE` - Upgrade status is not populated.\n* `IN_PROGRESS` - The upgrade is in progress.\n* `SUCCESSFUL` - The upgrade successfully completed.\n* `FAILED` - The upgrade shows failed status.\n* `TERMINATED` - The upgrade has been terminated.", "type": "string", "enum": [ "NONE", "IN_PROGRESS", "SUCCESSFUL", "FAILED", "TERMINATED" ], "default": "NONE", "x-omitempty": true }, "UpgradeType": { "description": "Desired upgrade mode to choose either direct download based upgrade or network share upgrade.\n* `direct_upgrade` - Upgrade mode is direct download.\n* `network_upgrade` - Upgrade mode is network upgrade.", "type": "string", "enum": [ "direct_upgrade", "network_upgrade" ], "default": "direct_upgrade", "x-createOnly": true, "x-omitempty": true }, "Distributable": { "$ref": "#/components/schemas/firmware.Distributable.Relationship", "description": "A reference to a firmwareDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Release": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Release.Relationship", "description": "A reference to a softwarerepositoryRelease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "UpgradeImpact": { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus.Relationship", "description": "A reference to a firmwareUpgradeImpactStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UpgradeStatus": { "$ref": "#/components/schemas/firmware.UpgradeStatus.Relationship", "description": "A reference to a firmwareUpgradeStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.UpgradeImpact": { "title": "Firmware:Upgrade Impact", "description": "The UpgradeImpact object provides a detailed analysis of the potential impact of firmware upgrades, offering insights into which components will be affected and whether a host reboot is required.it also offers insights on whether its a potential upgrade or downgrade comparing all the component versions of the endpoint \n#### Purpose\nUpgradeImpact serves as a pre-upgrade assessment tool, enabling administrators to understand the implications of firmware upgrades on system components. It aids in planning and decision-making by highlighting upgrade effects.\n#### Key Concepts\n- **Impact Analysis:** Delivers a comprehensive overview of the components affected by the upgrade, allowing informed decisions on proceeding with the upgrade.\n- **Reboot Requirement Assessment:** Identifies whether a system reboot will be necessary post-upgrade, ensuring proper planning and minimizing downtime.\n- **Pre-Upgrade Insight:** Provides valuable information prior to executing upgrades, facilitating strategic planning and risk mitigation.\n- **Secure Access:** Equipped with controlled access mechanisms, ensuring sensitive impact data is handled securely and appropriately.", "x-allOf-name": "firmware.UpgradeImpact", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeImpactBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeImpact', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.UpgradeImpact" ], "default": "firmware.UpgradeImpact", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.UpgradeImpact" ], "default": "firmware.UpgradeImpact", "x-enum-as-string": true }, "ExcludeComponentList": { "type": "array", "items": { "description": "The components to exclude from the chassis firmware upgrade.\n* `none` - If no component is selected for exclusion.\n* `local-disk` - Component to be excluded is local disk.\n* `psu` - Component to be excluded is PSU.\n* `xfm` - Component to be excluded is XFM.", "type": "string", "enum": [ "none", "local-disk", "psu", "xfm" ], "default": "none", "x-omitempty": true }, "nullable": true }, "XfmUpgradeOption": { "description": "XFM upgrade option Full or Partial Disruption.\n* `none` - If no option is selected for exclusion.\n* `full-shutdown` - PSX Switch in XFM will be upgraded in single action.\n* `partial-shutdown` - PSX Switch in XFM will be upgraded one after other.", "type": "string", "enum": [ "none", "full-shutdown", "partial-shutdown" ], "default": "none", "x-omitempty": true }, "Chassis": { "description": "An array of relationships to equipmentChassis resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Chassis.Relationship" }, "nullable": true }, "Device": { "description": "An array of relationships to assetDeviceRegistration resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship" }, "nullable": true, "readOnly": true }, "Distributable": { "$ref": "#/components/schemas/firmware.Distributable.Relationship", "description": "A reference to a firmwareDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "NetworkElements": { "description": "An array of relationships to networkElement resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship" }, "nullable": true }, "NetworkSecureRouter": { "description": "An array of relationships to networkSecureRouter resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship" }, "nullable": true }, "PciNode": { "description": "An array of relationships to pciNode resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Node.Relationship" }, "nullable": true }, "Release": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.Release.Relationship", "description": "A reference to a softwarerepositoryRelease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Server": { "description": "An array of relationships to computePhysical resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Physical.Relationship" }, "nullable": true } } } ] }, "firmware.UpgradeImpactBase": { "title": "Firmware:Upgrade Impact Base", "description": "Before submitting firmware upgrade operation, the estimate impact helps to know the list of components be impacted and require host reboot. This cannot be used for network share based upgrade.", "x-allOf-name": "firmware.UpgradeImpactBase", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeImpactBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.UpgradeImpact", "firmware.UpgradeImpactStatus" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "firmware.UpgradeImpact", "firmware.UpgradeImpactStatus" ], "x-enum-as-string": true }, "Components": { "type": "array", "items": { "description": "List of components to be upgraded.\n* `ALL` - This represents all the components.\n* `ALL,HDD` - This represents all the components plus the HDDs.\n* `Drive-U.2` - This represents the U.2 drives that are SFF/LFF drives (mostly all the drives will fall under this category).\n* `Storage` - This represents the storage controller components.\n* `None` - This represents none of the components.\n* `NXOS` - This represents NXOS components.\n* `ESU` - This represents ESU components.\n* `IOM` - This represents IOM components.\n* `PSU` - This represents PSU components.\n* `CIMC` - This represents CIMC components.\n* `BIOS` - This represents BIOS components.\n* `PCIE` - This represents PCIE components.\n* `Drive` - This represents Drive components.\n* `DIMM` - This represents DIMM components.\n* `BoardController` - This represents Board Controller components.\n* `StorageController` - This represents Storage Controller components.\n* `Storage-Sasexpander` - This represents Storage Sas-Expander components.\n* `Storage-U.2` - This represents U2 Storage Controller components.\n* `HBA` - This represents HBA components.\n* `GPU` - This represents GPU components.\n* `SasExpander` - This represents SasExpander components.\n* `MSwitch` - This represents mSwitch components.\n* `CMC` - This represents CMC components.\n* `PSX` - This represents PSX components.", "type": "string", "enum": [ "ALL", "ALL,HDD", "Drive-U.2", "Storage", "None", "NXOS", "ESU", "IOM", "PSU", "CIMC", "BIOS", "PCIE", "Drive", "DIMM", "BoardController", "StorageController", "Storage-Sasexpander", "Storage-U.2", "HBA", "GPU", "SasExpander", "MSwitch", "CMC", "PSX" ], "default": "ALL", "x-omitempty": true }, "nullable": true }, "ComputationState": { "description": "Captures the status of an upgrade impact calculation. Indicates whether the calculation is complete, in progress or the calculation is impossible due to the absence of the target image on the endpoint.\n* `Inprogress` - Upgrade impact calculation is in progress.\n* `Completed` - Upgrade impact calculation is completed.\n* `Unavailable` - Upgrade impact is not available since image is not present in FI.", "type": "string", "enum": [ "Inprogress", "Completed", "Unavailable" ], "default": "Inprogress", "x-omitempty": true }, "ExcludeComponents": { "type": "array", "items": { "description": "List of components to be excluded from upgrade.\n* `ALL` - This represents all the components.\n* `ALL,HDD` - This represents all the components plus the HDDs.\n* `Drive-U.2` - This represents the U.2 drives that are SFF/LFF drives (mostly all the drives will fall under this category).\n* `Storage` - This represents the storage controller components.\n* `None` - This represents none of the components.\n* `NXOS` - This represents NXOS components.\n* `ESU` - This represents ESU components.\n* `IOM` - This represents IOM components.\n* `PSU` - This represents PSU components.\n* `CIMC` - This represents CIMC components.\n* `BIOS` - This represents BIOS components.\n* `PCIE` - This represents PCIE components.\n* `Drive` - This represents Drive components.\n* `DIMM` - This represents DIMM components.\n* `BoardController` - This represents Board Controller components.\n* `StorageController` - This represents Storage Controller components.\n* `Storage-Sasexpander` - This represents Storage Sas-Expander components.\n* `Storage-U.2` - This represents U2 Storage Controller components.\n* `HBA` - This represents HBA components.\n* `GPU` - This represents GPU components.\n* `SasExpander` - This represents SasExpander components.\n* `MSwitch` - This represents mSwitch components.\n* `CMC` - This represents CMC components.\n* `PSX` - This represents PSX components.", "type": "string", "enum": [ "ALL", "ALL,HDD", "Drive-U.2", "Storage", "None", "NXOS", "ESU", "IOM", "PSU", "CIMC", "BIOS", "PCIE", "Drive", "DIMM", "BoardController", "StorageController", "Storage-Sasexpander", "Storage-U.2", "HBA", "GPU", "SasExpander", "MSwitch", "CMC", "PSX" ], "default": "ALL", "x-omitempty": true }, "nullable": true }, "Impacts": { "type": "array", "items": { "description": "List the endpoint impacts for the selected server or fabric and selected distributable.", "$ref": "#/components/schemas/firmware.BaseImpact", "x-omitempty": true }, "nullable": true }, "Summary": { "description": "The summary on the component or components getting impacted by the upgrade.\n* `Basic` - Summary of a single instance involved in the upgrade operation.\n* `Detail` - Summary of the collection of single instances for a complex component involved in the upgrade operation. For example, in case of a server upgrade, a detailed summary indicates impact of all the single instances which are part of the server, such as storage controller, drives, and BIOS.", "type": "string", "enum": [ "Basic", "Detail" ], "default": "Basic", "x-omitempty": true } } } ] }, "firmware.UpgradeImpactStatus.Response": { "description": "The response body of a HTTP GET request for the 'firmware.UpgradeImpactStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.UpgradeImpactStatus' resources.", "x-one-of-name": "firmware.UpgradeImpactStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.UpgradeImpactStatus.Relationship": { "description": "A relationship to the 'firmware.UpgradeImpactStatus' resource, or the expanded 'firmware.UpgradeImpactStatus' resource, or the 'null' value.", "x-one-of-name": "firmware.UpgradeImpactStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.UpgradeImpactStatus": { "title": "Firmware:Upgrade Impact Status", "description": "Captures the impact for an upgrade.", "x-allOf-name": "firmware.UpgradeImpactStatus", "allOf": [ { "$ref": "#/components/schemas/firmware.UpgradeImpactBase" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeImpactStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.UpgradeImpactStatus" ], "default": "firmware.UpgradeImpactStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.UpgradeImpactStatus" ], "default": "firmware.UpgradeImpactStatus", "x-enum-as-string": true }, "Upgrade": { "$ref": "#/components/schemas/firmware.UpgradeBase.Relationship", "description": "A reference to a firmwareUpgradeBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.UpgradeImpactStatus.List": { "title": "List of 'firmware.UpgradeImpactStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.UpgradeImpactStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.UpgradeImpactStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.UpgradeImpactStatus" }, "nullable": true } } } ] }, "firmware.UpgradeStatus.Response": { "description": "The response body of a HTTP GET request for the 'firmware.UpgradeStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'firmware.UpgradeStatus' resources.", "x-one-of-name": "firmware.UpgradeStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/firmware.UpgradeStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "firmware.UpgradeStatus.Relationship": { "description": "A relationship to the 'firmware.UpgradeStatus' resource, or the expanded 'firmware.UpgradeStatus' resource, or the 'null' value.", "x-one-of-name": "firmware.UpgradeStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/firmware.UpgradeStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "firmware.UpgradeStatus": { "title": "Firmware:Upgrade Status", "description": "The UpgradeStatus object provides comprehensive status information for firmware upgrade operations. It tracks the progress and outcomes of both the download and upgrade stages, offering detailed insights into the entire process.\n #### Purpose\n UpgradeStatus object is designed to give users a clear and detailed view of an ongoing or completed firmware upgrade. It consolidates information regarding the download of firmware images and the subsequent upgrade process on the target endpoint, enabling monitoring and troubleshooting. \n #### Key Concepts\n - **Detailed Stage Tracking:** Separates and reports on distinct stages of the upgrade, such as download and the actual firmware flashing, providing granular progress updates.\n - **Download Metrics:** Includes specific metrics like download percentage and messages from the endpoint during the download phase.\n - **Overall Operation Status:** Provides an overall status, percentage, and error messages for the entire upgrade operation.\n - **Power State Monitoring:** Captures the server's power status before and after the upgrade submission, which is crucial for understanding operational state changes.\n - **Firmware Version Tracking:** Records both the source (pre-upgrade) and target (post-upgrade) firmware versions for clear verification.\n - **Workflow Integration:** Links to the runtime instance of the workflow orchestrating the upgrade, allowing for comprehensive process tracking.\n - **Extends CacheStatus:** Inherits capabilities from `connector.CacheStatus`, indicating its role in managing file download aspects of the upgrade.", "x-allOf-name": "firmware.UpgradeStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.CacheStatus" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.UpgradeStatus" ], "default": "firmware.UpgradeStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.UpgradeStatus" ], "default": "firmware.UpgradeStatus", "x-enum-as-string": true }, "DownloadMessage": { "description": "The message from the endpoint during the download.", "type": "string", "x-omitempty": true }, "DownloadPercentage": { "description": "The percentage of the image downloaded in the endpoint.", "type": "integer", "format": "int64", "x-omitempty": true }, "DownloadStage": { "description": "The image download stages. Example:downloading, flashing.", "type": "string", "x-omitempty": true }, "EpPowerStatus": { "description": "The server power status after the upgrade request is submitted in the endpoint.\n* `none` - Server power status is none.\n* `powered on` - Server power status is powered on.\n* `powered off` - Server power status is powered off.", "type": "string", "enum": [ "none", "powered on", "powered off" ], "default": "none", "x-omitempty": true }, "InitialPowerStatus": { "description": "The server power status before the upgrade request is submitted in the endpoint.\n* `none` - Server power status is none.\n* `powered on` - Server power status is powered on.\n* `powered off` - Server power status is powered off.", "type": "string", "enum": [ "none", "powered on", "powered off" ], "default": "none", "x-omitempty": true }, "IsCdnDisabled": { "description": "A boolean flag which indicates that the generated pre-signed url is not a CDN URL when set to true.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "OverallError": { "description": "The reason for the operation failure.", "type": "string", "x-omitempty": true }, "OverallPercentage": { "description": "The overall percentage of the operation.", "type": "integer", "format": "int64", "x-omitempty": true }, "Overallstatus": { "description": "The overall status of the operation.\n* `none` - Upgrade stage is no upgrade stage.\n* `started` - Upgrade stage is started.\n* `prepare initiating` - Upgrade configuration is being prepared.\n* `prepare initiated` - Upgrade configuration is initiated.\n* `prepared` - Upgrade configuration is prepared.\n* `download initiating` - Upgrade stage is download initiating.\n* `download initiated` - Upgrade stage is download initiated.\n* `downloading` - Upgrade stage is downloading.\n* `downloaded` - Upgrade stage is downloaded.\n* `upgrade initiating on fabric A` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint.\n* `upgrade initiated on fabric A` - Upgrade stage is in upgrade initiated when the upgrade has started in endpoint.\n* `upgrading fabric A` - Upgrade stage is in upgrading when the upgrade requires reboot to complete.\n* `rebooting fabric A` - Upgrade is in rebooting when the endpoint is being rebooted.\n* `upgraded fabric A` - Upgrade stage is in upgraded when the corresponding endpoint has completed.\n* `upgrade initiating on fabric B` - Upgrade stage is in upgrade initiating when upgrade is being started in endopint.\n* `upgrade initiated on fabric B` - Upgrade stage is in upgrade initiated when upgrade has started in endpoint.\n* `upgrading fabric B` - Upgrade stage is in upgrading when the upgrade requires reboot to complete.\n* `rebooting fabric B` - Upgrade is in rebooting when the endpoint is being rebooted.\n* `upgraded fabric B` - Upgrade stage is in upgraded when the corresponding endpoint has completed.\n* `upgrade initiating` - Upgrade stage is upgrade initiating.\n* `upgrade initiated` - Upgrade stage is upgrade initiated.\n* `upgrading` - Upgrade stage is upgrading.\n* `oob images staging` - Out-of-band component images staging.\n* `oob images staged` - Out-of-band component images staged.\n* `rebooting` - Upgrade is rebooting the endpoint.\n* `upgraded` - Upgrade stage is upgraded.\n* `success` - Upgrade stage is success.\n* `failed` - Upgrade stage is upgrade failed.\n* `terminated` - Upgrade stage is terminated.\n* `pending` - Upgrade stage is pending.\n* `ReadyForCache` - The image is ready to be cached into the Intersight Appliance.\n* `Caching` - The image will be cached into Intersight Appliance or an endpoint cache.\n* `Cached` - The image has been cached into the Intersight Appliance or endpoint cache.\n* `CachingFailed` - The image caching into the Intersight Appliance failed or endpoint cache.", "type": "string", "enum": [ "none", "started", "prepare initiating", "prepare initiated", "prepared", "download initiating", "download initiated", "downloading", "downloaded", "upgrade initiating on fabric A", "upgrade initiated on fabric A", "upgrading fabric A", "rebooting fabric A", "upgraded fabric A", "upgrade initiating on fabric B", "upgrade initiated on fabric B", "upgrading fabric B", "rebooting fabric B", "upgraded fabric B", "upgrade initiating", "upgrade initiated", "upgrading", "oob images staging", "oob images staged", "rebooting", "upgraded", "success", "failed", "terminated", "pending", "ReadyForCache", "Caching", "Cached", "CachingFailed" ], "default": "none", "x-omitempty": true }, "PendingType": { "description": "Pending reason for the upgrade waiting.\n* `none` - Upgrade pending reason is none.\n* `pending for next reboot` - Upgrade pending reason is pending for next reboot.", "type": "string", "enum": [ "none", "pending for next reboot" ], "default": "none", "x-omitempty": true }, "SdCardDownloadError": { "description": "The error message from the endpoint during the SD card download.", "type": "string", "x-omitempty": true }, "SourceFirmwareVersion": { "description": "CIMC firmware version of the server prior to the upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetFirmwareVersion": { "description": "CIMC firmware version of the server post the upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "Upgrade": { "$ref": "#/components/schemas/firmware.UpgradeBase.Relationship", "description": "A reference to a firmwareUpgradeBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Workflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "firmware.UpgradeStatus.List": { "title": "List of 'firmware.UpgradeStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'firmware.UpgradeStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'firmware.UpgradeStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.UpgradeStatus" }, "nullable": true } } } ] }, "firmware.UpgradeValidity": { "title": "Firmware:Upgrade Validity", "description": "The UpgradeValidity object is a crucial element in the firmware upgrade process, ensuring that the target endpoint meets all necessary conditions for a successful firmware upgrade. This provides basic validity checks that are fundamental to initiating a firmware upgrade operation.\n#### Purpose\nUpgradeValidity serves as a validation checkpoint before performing firmware upgrades. It evaluates the endpoint's readiness, confirming whether the platform requirements are satisfied to proceed with the upgrade process.\n#### Key Concepts\n- **Pre-Upgrade Validation:** Conducts essential checks to determine if the endpoint is a suitable candidate for firmware upgrade, preventing potential issues during the upgrade process.\n- **Platform Requirement Analysis:** Focuses on verifying the endpoint's compatibility and capability to support the desired firmware upgrade, ensuring system integrity and efficiency.\n- **Standalone Server Support:** Specifically tailored to provide upgrade validity checks for standalone servers, optimizing the upgrade workflow for these environments.\n- **Read-Only Access:** Provides a secure and controlled mechanism for administrators to assess upgrade readiness without altering system settings.", "x-allOf-name": "firmware.UpgradeValidity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.UpgradeValidity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.UpgradeValidity" ], "default": "firmware.UpgradeValidity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.UpgradeValidity" ], "default": "firmware.UpgradeValidity", "x-enum-as-string": true }, "ErrorMessage": { "description": "The error string returned while checking for a target device's validity for firmware upgrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsValid": { "description": "This flag denotes whether the target device is a valid target for firmware upgrade.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "firmware.VersionMap": { "title": "Firmware:Version Map", "description": "Maps device firmware version to bundle version. Device firmware is packaged as part of the bundle. Multiple bundle versions may contain identical device firmware.", "x-allOf-name": "firmware.VersionMap", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'firmware.VersionMap', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "firmware.VersionMap" ], "default": "firmware.VersionMap", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "firmware.VersionMap" ], "default": "firmware.VersionMap", "x-enum-as-string": true }, "BundleVersion": { "description": "Bundle version. Usually the first released bundle containing the specific device firmware version.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceFirmwareVersion": { "description": "Bundled device firmware version.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "graphics.Card.Response": { "description": "The response body of a HTTP GET request for the 'graphics.Card' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'graphics.Card' resources.", "x-one-of-name": "graphics.Card.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/graphics.Card.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "graphics.Card.Relationship": { "description": "A relationship to the 'graphics.Card' resource, or the expanded 'graphics.Card' resource, or the 'null' value.", "x-one-of-name": "graphics.Card.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/graphics.Card" } ], "discriminator": { "propertyName": "ClassId" } }, "graphics.Card": { "title": "Graphics:Card", "description": "Graphics Card present in a server.", "x-allOf-name": "graphics.Card", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'graphics.Card', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "graphics.Card" ], "default": "graphics.Card", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "graphics.Card" ], "default": "graphics.Card", "x-enum-as-string": true }, "CardId": { "description": "The id of the graphics card.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field displays the description of the Graphics Processing Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The device id of the graphics card.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExpanderSlot": { "description": "The expander slot information of the card.", "type": "string", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "The firmware version of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "GpuId": { "description": "The identifier of the graphics processor unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPlatformSupported": { "description": "This field indicates whether the Graphics Processing Unit is supported on the server or not.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Mode": { "description": "The current mode of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumGpus": { "description": "The number of controllers under each card.", "type": "string", "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "This field displays the health status of the Graphics Processing Unit.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The current operational state of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field displays the part number of the Graphics Processing Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciAddress": { "description": "The PCI address of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciAddressList": { "description": "This list contains the PCI address of all controllers for corresponding card.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The PCI slot name of the graphics card.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field displays the product ID of the Graphics Processing Unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubDeviceId": { "description": "The sub device id of the graphics processor unit.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SubVendorId": { "description": "The sub vendor id of the graphics processor unit.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VendorId": { "description": "The vendor id of the graphics processor unit.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EquipmentEnclosureElement": { "$ref": "#/components/schemas/equipment.EnclosureElement.Relationship", "description": "A reference to a equipmentEnclosureElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentInterconnect": { "$ref": "#/components/schemas/equipment.Interconnect.Relationship", "description": "A reference to a equipmentInterconnect resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentSharedGraphicsCard": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.Relationship", "description": "A reference to a equipmentSharedGraphicsCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GraphicsControllers": { "description": "An array of relationships to graphicsController resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Controller.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciDevice": { "$ref": "#/components/schemas/pci.Device.Relationship", "description": "A reference to a pciDevice resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "graphics.Card.List": { "title": "List of 'graphics.Card' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'graphics.Card' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'graphics.Card' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card" }, "nullable": true } } } ] }, "graphics.Controller.Response": { "description": "The response body of a HTTP GET request for the 'graphics.Controller' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'graphics.Controller' resources.", "x-one-of-name": "graphics.Controller.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/graphics.Controller.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "graphics.Controller.Relationship": { "description": "A relationship to the 'graphics.Controller' resource, or the expanded 'graphics.Controller' resource, or the 'null' value.", "x-one-of-name": "graphics.Controller.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/graphics.Controller" } ], "discriminator": { "propertyName": "ClassId" } }, "graphics.Controller": { "title": "Graphics:Controller", "description": "Controller for a Graphics Card.", "x-allOf-name": "graphics.Controller", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'graphics.Controller', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "graphics.Controller" ], "default": "graphics.Controller", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "graphics.Controller" ], "default": "graphics.Controller", "x-enum-as-string": true }, "ControllerId": { "description": "The id of the graphics controller.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PciAddr": { "description": "The PCI address of the graphics controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The PCI slot information of the graphics controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "GraphicsCard": { "$ref": "#/components/schemas/graphics.Card.Relationship", "description": "A reference to a graphicsCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "graphics.Controller.List": { "title": "List of 'graphics.Controller' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'graphics.Controller' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'graphics.Controller' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Controller" }, "nullable": true } } } ] }, "inventory.Base.Relationship": { "description": "A relationship to the 'inventory.Base' resource, or the expanded 'inventory.Base' resource, or the 'null' value.", "x-one-of-name": "inventory.Base.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/inventory.Base" } ], "discriminator": { "propertyName": "ClassId" } }, "inventory.Base": { "title": "Inventory:Base", "description": "Base class for all inventory MOs.", "x-allOf-name": "inventory.Base", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.Base', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "adapter.ExtEthInterface", "adapter.HostEthInterface", "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.BootDevice", "bios.BootMode", "bios.SystemBootOrder", "bios.TokenSettings", "bios.Unit", "bios.VfSelectMemoryRasConfiguration", "boot.CddDevice", "boot.DeviceBootMode", "boot.DeviceBootSecurity", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "compute.Blade", "compute.Board", "compute.Mapping", "compute.Personality", "compute.RackUnit", "compute.ServerPowerParameters", "compute.ServerSetting", "compute.Vmedia", "console.ConsoleConfig", "equipment.Chassis", "equipment.ChassisController", "equipment.EnclosureElement", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoExpander", "equipment.LocatorLed", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.Sensor", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "ether.HostPort", "ether.InterSwitchPort", "ether.LanPort", "ether.NetworkPort", "ether.PhysicalPort", "ether.PortChannel", "fault.Instance", "fc.Neighbor", "fc.PhysicalPort", "fc.PortChannel", "firmware.RunningFirmware", "graphics.Card", "graphics.Controller", "inventory.GenericInventory", "inventory.GenericInventoryHolder", "ls.ServiceProfile", "management.Controller", "management.Entity", "management.Interface", "memory.Array", "memory.PersistentMemoryConfigResult", "memory.PersistentMemoryConfiguration", "memory.PersistentMemoryNamespace", "memory.PersistentMemoryNamespaceConfigResult", "memory.PersistentMemoryRegion", "memory.PersistentMemoryUnit", "memory.Unit", "meraki.Device", "network.DiscoveredNeighbor", "network.Dns", "network.Element", "network.FcZoneInfo", "network.FeatureControl", "network.InterfaceList", "network.LicenseFile", "network.SecureRouter", "network.SecureRouterSetting", "network.SupervisorCard", "network.TelemetryCheck", "network.Vethernet", "network.Vfc", "network.VlanPortInfo", "network.VpcDomain", "network.VpcMember", "network.VpcPeer", "network.Vrf", "ntp.NtpServer", "pci.CoprocessorCard", "pci.Device", "pci.Endpoint", "pci.Link", "pci.Node", "pci.NodeSetting", "pci.Port", "pci.Slot", "pci.Switch", "pci.Zone", "port.Group", "port.MacBinding", "port.SubGroup", "processor.Unit", "rack.UnitPersonality", "security.Unit", "storage.BatteryBackupUnit", "storage.Controller", "storage.ControllerDrive", "storage.DiskGroup", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.EnclosureDiskSlotEp", "storage.FileItem", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilController", "storage.FlexUtilPhysicalDrive", "storage.FlexUtilVirtualDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.Item", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PhysicalDiskUsage", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.PureFlashBladeSystem", "storage.SasExpander", "storage.SasPort", "storage.Span", "storage.VdMemberEp", "storage.VirtualDrive", "storage.VirtualDriveContainer", "storage.VirtualDriveExtension", "top.System" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "adapter.ExtEthInterface", "adapter.HostEthInterface", "adapter.HostFcInterface", "adapter.HostIscsiInterface", "adapter.Unit", "adapter.UnitExpander", "bios.BootDevice", "bios.BootMode", "bios.SystemBootOrder", "bios.TokenSettings", "bios.Unit", "bios.VfSelectMemoryRasConfiguration", "boot.CddDevice", "boot.DeviceBootMode", "boot.DeviceBootSecurity", "boot.HddDevice", "boot.IscsiDevice", "boot.NvmeDevice", "boot.PchStorageDevice", "boot.PxeDevice", "boot.SanDevice", "boot.SdDevice", "boot.UefiShellDevice", "boot.UsbDevice", "boot.VmediaDevice", "catalystsdwan.VedgeDevice", "catalystsdwan.WanEdgeDevice", "compute.Blade", "compute.Board", "compute.Mapping", "compute.Personality", "compute.RackUnit", "compute.ServerPowerParameters", "compute.ServerSetting", "compute.Vmedia", "console.ConsoleConfig", "equipment.Chassis", "equipment.ChassisController", "equipment.EnclosureElement", "equipment.ExpanderModule", "equipment.Fan", "equipment.FanControl", "equipment.FanModule", "equipment.Fex", "equipment.Fru", "equipment.HybridDriveSlot", "equipment.Interconnect", "equipment.IoCard", "equipment.IoExpander", "equipment.LocatorLed", "equipment.Psu", "equipment.PsuControl", "equipment.RackEnclosure", "equipment.RackEnclosureSlot", "equipment.Riser", "equipment.Sensor", "equipment.SharedAdapterUnit", "equipment.SharedGraphicsCard", "equipment.SharedIoModule", "equipment.SwitchCard", "equipment.SystemIoController", "equipment.Tpm", "equipment.Transceiver", "ether.HostPort", "ether.InterSwitchPort", "ether.LanPort", "ether.NetworkPort", "ether.PhysicalPort", "ether.PortChannel", "fault.Instance", "fc.Neighbor", "fc.PhysicalPort", "fc.PortChannel", "firmware.RunningFirmware", "graphics.Card", "graphics.Controller", "inventory.GenericInventory", "inventory.GenericInventoryHolder", "ls.ServiceProfile", "management.Controller", "management.Entity", "management.Interface", "memory.Array", "memory.PersistentMemoryConfigResult", "memory.PersistentMemoryConfiguration", "memory.PersistentMemoryNamespace", "memory.PersistentMemoryNamespaceConfigResult", "memory.PersistentMemoryRegion", "memory.PersistentMemoryUnit", "memory.Unit", "meraki.Device", "network.DiscoveredNeighbor", "network.Dns", "network.Element", "network.FcZoneInfo", "network.FeatureControl", "network.InterfaceList", "network.LicenseFile", "network.SecureRouter", "network.SecureRouterSetting", "network.SupervisorCard", "network.TelemetryCheck", "network.Vethernet", "network.Vfc", "network.VlanPortInfo", "network.VpcDomain", "network.VpcMember", "network.VpcPeer", "network.Vrf", "ntp.NtpServer", "pci.CoprocessorCard", "pci.Device", "pci.Endpoint", "pci.Link", "pci.Node", "pci.NodeSetting", "pci.Port", "pci.Slot", "pci.Switch", "pci.Zone", "port.Group", "port.MacBinding", "port.SubGroup", "processor.Unit", "rack.UnitPersonality", "security.Unit", "storage.BatteryBackupUnit", "storage.Controller", "storage.ControllerDrive", "storage.DiskGroup", "storage.DiskSlot", "storage.Enclosure", "storage.EnclosureDisk", "storage.EnclosureDiskSlotEp", "storage.FileItem", "storage.FlexFlashController", "storage.FlexFlashControllerProps", "storage.FlexFlashPhysicalDrive", "storage.FlexFlashVirtualDrive", "storage.FlexUtilController", "storage.FlexUtilPhysicalDrive", "storage.FlexUtilVirtualDrive", "storage.HitachiArray", "storage.HitachiController", "storage.HitachiDisk", "storage.Item", "storage.NetAppBaseDisk", "storage.NetAppCluster", "storage.NetAppNode", "storage.PhysicalDisk", "storage.PhysicalDiskExtension", "storage.PhysicalDiskUsage", "storage.PureArray", "storage.PureController", "storage.PureDisk", "storage.PureFlashBladeSystem", "storage.SasExpander", "storage.SasPort", "storage.Span", "storage.VdMemberEp", "storage.VirtualDrive", "storage.VirtualDriveContainer", "storage.VirtualDriveExtension", "top.System" ], "x-enum-as-string": true }, "DeviceMoId": { "description": "The database identifier of the registered device of an object.", "type": "string", "readOnly": true, "x-omitempty": true }, "Dn": { "description": "The Distinguished Name unambiguously identifies an object in the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Rn": { "description": "The Relative Name uniquely identifies an object within a given context.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "inventory.DeviceInfo.Response": { "description": "The response body of a HTTP GET request for the 'inventory.DeviceInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'inventory.DeviceInfo' resources.", "x-one-of-name": "inventory.DeviceInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/inventory.DeviceInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "inventory.DeviceInfo.Relationship": { "description": "A relationship to the 'inventory.DeviceInfo' resource, or the expanded 'inventory.DeviceInfo' resource, or the 'null' value.", "x-one-of-name": "inventory.DeviceInfo.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/inventory.DeviceInfo" } ], "discriminator": { "propertyName": "ClassId" } }, "inventory.DeviceInfo": { "title": "Inventory:Device Info", "description": "Information pertaining to a Registered Device in Intersight which is pertinent to Inventory Microservice.", "x-allOf-name": "inventory.DeviceInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.DeviceInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.DeviceInfo" ], "default": "inventory.DeviceInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.DeviceInfo" ], "default": "inventory.DeviceInfo", "x-enum-as-string": true }, "DisableEvents": { "description": "Subscribe/Unsubscribe events for the device.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EventCounter": { "description": "Information regarding the number of events recorded for this device.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EventCounterEnabled": { "description": "Indicates whether the event counter enabled for the device.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Interval": { "description": "The time interval (in hours) between job runs.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "JobInfo": { "type": "array", "items": { "description": "Information regarding all inventory collection jobs for the device.", "$ref": "#/components/schemas/inventory.JobInfo", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LastReInventoryTime": { "description": "Last Reinventory time of the device.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ReInventoryCount": { "description": "Number of full inventory within the given time.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ClusterMember": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.ClusterMember.Relationship", "description": "A reference to a assetClusterMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "inventory.DeviceInfo.List": { "title": "List of 'inventory.DeviceInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'inventory.DeviceInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'inventory.DeviceInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.DeviceInfo" }, "nullable": true } } } ] }, "inventory.DnMoBinding.Response": { "description": "The response body of a HTTP GET request for the 'inventory.DnMoBinding' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'inventory.DnMoBinding' resources.", "x-one-of-name": "inventory.DnMoBinding.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/inventory.DnMoBinding.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "inventory.DnMoBinding": { "title": "Inventory:Dn Mo Binding", "description": "DnMoBinding provides a binding between a Intersight MO and a UCSM MO which has a DN.", "x-allOf-name": "inventory.DnMoBinding", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.DnMoBinding', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.DnMoBinding" ], "default": "inventory.DnMoBinding", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.DnMoBinding" ], "default": "inventory.DnMoBinding", "x-enum-as-string": true }, "Dn": { "description": "The Distinguished Name for this object, used to uniquely identify this object.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetMoId": { "description": "The MO ID of the target MO for this particular Distinguished Name (dn).", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetMoType": { "description": "The type of the target MO for this particular Distinguished Name (dn).", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "inventory.DnMoBinding.List": { "title": "List of 'inventory.DnMoBinding' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'inventory.DnMoBinding' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'inventory.DnMoBinding' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.DnMoBinding" }, "nullable": true } } } ] }, "inventory.GenericInventory.Response": { "description": "The response body of a HTTP GET request for the 'inventory.GenericInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'inventory.GenericInventory' resources.", "x-one-of-name": "inventory.GenericInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/inventory.GenericInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "inventory.GenericInventory.Relationship": { "description": "A relationship to the 'inventory.GenericInventory' resource, or the expanded 'inventory.GenericInventory' resource, or the 'null' value.", "x-one-of-name": "inventory.GenericInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/inventory.GenericInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "inventory.GenericInventory": { "title": "Inventory:Generic Inventory", "description": "Any inventory which is represented as a key / value pair. Example - moInvKv in UCSM representing OS tools running on ESX.", "x-allOf-name": "inventory.GenericInventory", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.GenericInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.GenericInventory" ], "default": "inventory.GenericInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.GenericInventory" ], "default": "inventory.GenericInventory", "x-enum-as-string": true }, "Key": { "description": "Key of inventory data for Generic Inventory data set.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of inventory data for Generic Inventory data set.", "type": "string", "readOnly": true, "x-omitempty": true }, "Value": { "description": "Value of inventory data for Generic Inventory data set.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryGenericInventoryHolder": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder.Relationship", "description": "A reference to a inventoryGenericInventoryHolder resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "inventory.GenericInventory.List": { "title": "List of 'inventory.GenericInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'inventory.GenericInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'inventory.GenericInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.GenericInventory" }, "nullable": true } } } ] }, "inventory.GenericInventoryHolder.Response": { "description": "The response body of a HTTP GET request for the 'inventory.GenericInventoryHolder' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'inventory.GenericInventoryHolder' resources.", "x-one-of-name": "inventory.GenericInventoryHolder.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/inventory.GenericInventoryHolder.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "inventory.GenericInventoryHolder.Relationship": { "description": "A relationship to the 'inventory.GenericInventoryHolder' resource, or the expanded 'inventory.GenericInventoryHolder' resource, or the 'null' value.", "x-one-of-name": "inventory.GenericInventoryHolder.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" } ], "discriminator": { "propertyName": "ClassId" } }, "inventory.GenericInventoryHolder": { "title": "Inventory:Generic Inventory Holder", "description": "A container class for generic inventory.", "x-allOf-name": "inventory.GenericInventoryHolder", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.GenericInventoryHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.GenericInventoryHolder" ], "default": "inventory.GenericInventoryHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.GenericInventoryHolder" ], "default": "inventory.GenericInventoryHolder", "x-enum-as-string": true }, "Endpoint": { "description": "The endpoint represented by this holder.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GenericInventory": { "description": "An array of relationships to inventoryGenericInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.GenericInventory.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "inventory.GenericInventoryHolder.List": { "title": "List of 'inventory.GenericInventoryHolder' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'inventory.GenericInventoryHolder' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'inventory.GenericInventoryHolder' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/inventory.GenericInventoryHolder" }, "nullable": true } } } ] }, "inventory.Interface.Relationship": { "description": "A relationship to the 'inventory.Interface' resource, or the expanded 'inventory.Interface' resource, or the 'null' value.", "x-one-of-name": "inventory.Interface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/inventory.Interface" } ], "discriminator": { "propertyName": "ClassId" } }, "inventory.Interface": { "title": "Inventory:Interface", "description": "Abstract base class for all interfaces.", "x-allOf-name": "inventory.Interface", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" } ] }, "inventory.InventoryMo": { "title": "Inventory:Inventory Mo", "description": "Complex type representing the inventory MO.", "x-allOf-name": "inventory.InventoryMo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.InventoryMo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.InventoryMo" ], "default": "inventory.InventoryMo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.InventoryMo" ], "default": "inventory.InventoryMo", "x-enum-as-string": true }, "MoDn": { "description": "The UCS DN of the MO for which the latest inventory to be fetched. If this property is empty and moId property has the Moid of the MO to be updated, the Moid will be used. If this property is empty and moId is also empty, all the MOs of the given moType will be updated.", "type": "string", "x-omitempty": true }, "MoId": { "description": "The MO id of an MO for which the latest inventory to be fetched. If this property is empty and moDn property has the UCS DN of the MO to be updated, the DN will be used. If this property is empty and moDn is also empty, all the MOs of the given moType will be updated.", "type": "string", "x-omitempty": true }, "MoType": { "description": "The type of the MO for which the latest inventory to be fetched.", "type": "string", "x-omitempty": true } } } ] }, "inventory.JobInfo": { "title": "Inventory:Job Info", "description": "The runtime information about a job scheduled on a managed device.", "x-allOf-name": "inventory.JobInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.JobInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.JobInfo" ], "default": "inventory.JobInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.JobInfo" ], "default": "inventory.JobInfo", "x-enum-as-string": true }, "ExecutionStatus": { "description": "The execution status of the job scheduled.\n* `Unknown` - Operational job status on a managed device is not known.\n* `Scheduled` - Job on a managed device is scheduled.\n* `Completed` - Job on a managed device is completed.\n* `Error` - Job on a managed device is errored out.", "type": "string", "enum": [ "Unknown", "Scheduled", "Completed", "Error" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "JobName": { "description": "The name of the job scheduled.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastProcessedTime": { "description": "Timestamp to indicate the last processed time for this job.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastScheduledTime": { "description": "Last timestamp when this inventory was scheduled.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Properties": { "type": "array", "items": { "description": "The properties of the job scheduled.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Regex": { "type": "array", "items": { "description": "Regex string to be used to match.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "inventory.Request": { "title": "Inventory:Request", "description": "Request MO allows the inventory of specific devices to be collected on demand. The inventory can be collected in three levels - all the MOs of a specific device, MOs of specific MO types for a given device or specific MO instances of specific MO types for a given device. These MO instances are used just to collect the requests and not persisted.", "x-allOf-name": "inventory.Request", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.Request', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.Request" ], "default": "inventory.Request", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.Request" ], "default": "inventory.Request", "x-enum-as-string": true }, "Mos": { "type": "array", "items": { "description": "The collection of specific inventory MOs that need to be fetched. The property is optional and if not present then all the MOs of the given device will be fetched.", "$ref": "#/components/schemas/inventory.InventoryMo", "x-omitempty": true }, "nullable": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "inventory.UemInfo": { "title": "Inventory:Uem Info", "description": "The runtime information about a Uem supported endpoint.", "x-allOf-name": "inventory.UemInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'inventory.UemInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "inventory.UemInfo" ], "default": "inventory.UemInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "inventory.UemInfo" ], "default": "inventory.UemInfo", "x-enum-as-string": true }, "ConnectionStatus": { "description": "Connections status of Uem endpoint.\n* `Unknown` - Connection status of UEM is not known.\n* `Connected` - UEM endpoint has an open TCP connection with device connector.\n* `Enabled` - Eventing is enabled on the UEM endpoint.\n* `Paused` - Eventing is paused on the UEM endpoint.\n* `Disabled` - Eventing is disabled on the UEM endpoint.\n* `Disconnected` - There is no TCP connection between the UEM endpoint and device connector.", "type": "string", "enum": [ "Unknown", "Connected", "Enabled", "Paused", "Disabled", "Disconnected" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "LastSequenceId": { "description": "Last Sequence ID in the UEM event frame received from the endpoint identified by endpointInfo.", "type": "integer", "format": "int64", "x-omitempty": true }, "PackageVersion": { "description": "Version of UEM package on the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProtocolVersion": { "description": "Version of UEM protocol running on the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "The switch ID to identify the path to the endpoint.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "ipmioverlan.Policy.Response": { "description": "The response body of a HTTP GET request for the 'ipmioverlan.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ipmioverlan.Policy' resources.", "x-one-of-name": "ipmioverlan.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ipmioverlan.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ipmioverlan.Policy": { "title": "IPMI Over LAN", "description": "The IPMI Over LAN Policy object is a reusable policy for configuring the Intelligent Platform Management Interface (IPMI) over LAN service on a server.\n#### Purpose\nThe purpose of this policy is to enable and secure out-of-band server management using the IPMI protocol. It allows administrators to control the state of the IPMI service, set the maximum privilege level for IPMI sessions, and configure an encryption key to secure communications.\n#### Key Concepts\n- **Service Control:** The policy allows administrators to enable or disable the IPMI over LAN service on the endpoint.\n- **Privilege Level Management:** It defines the highest privilege level (admin, user, or read-only) that can be assigned to an IPMI session, providing a layer of access control.\n- **Security:** An optional encryption key can be configured to encrypt IPMI traffic, enhancing the security of out-of-band management. The key is a write-only, encrypted property.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the IPMI settings to the assigned physical server.", "x-allOf-name": "ipmioverlan.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'ipmioverlan.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ipmioverlan.Policy" ], "default": "ipmioverlan.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ipmioverlan.Policy" ], "default": "ipmioverlan.Policy", "x-enum-as-string": true }, "Enabled": { "description": "State of the IPMI Over LAN service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "EncryptionKey": { "description": "The encryption key to use for IPMI communication. It should have an even number of hexadecimal characters and not exceed 40 characters. Use \u201c00\u201d to disable encryption key use. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. IPMI commands using this key should append zeroes to the key to achieve a length of 40 characters.", "type": "string", "pattern": "^[a-fA-F0-9]*$", "minLength": 0, "maxLength": 40, "writeOnly": true, "x-omitempty": true }, "IsEncryptionKeySet": { "description": "Indicates whether the value of the 'encryptionKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Privilege": { "description": "The highest privilege level that can be assigned to an IPMI session on a server. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. Privilege level user is not supported for B/X-Series servers.\n* `admin` - Privilege to perform all actions available through IPMI.\n* `user` - Privilege to perform some functions through IPMI but restriction on performing administrative tasks.\n* `read-only` - Privilege to view information throught IPMI but restriction on making any changes.", "type": "string", "enum": [ "admin", "user", "read-only" ], "default": "admin", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "ipmioverlan.Policy.List": { "title": "List of 'ipmioverlan.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ipmioverlan.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ipmioverlan.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ipmioverlan.Policy" }, "nullable": true } } } ] }, "ipmioverlan.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'ipmioverlan.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ipmioverlan.PolicyInventory' resources.", "x-one-of-name": "ipmioverlan.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ipmioverlan.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ipmioverlan.PolicyInventory": { "title": "IPMI Over LAN", "description": "The IPMI Over LAN Policy object is a reusable policy for configuring the Intelligent Platform Management Interface (IPMI) over LAN service on a server.\n#### Purpose\nThe purpose of this policy is to enable and secure out-of-band server management using the IPMI protocol. It allows administrators to control the state of the IPMI service, set the maximum privilege level for IPMI sessions, and configure an encryption key to secure communications.\n#### Key Concepts\n- **Service Control:** The policy allows administrators to enable or disable the IPMI over LAN service on the endpoint.\n- **Privilege Level Management:** It defines the highest privilege level (admin, user, or read-only) that can be assigned to an IPMI session, providing a layer of access control.\n- **Security:** An optional encryption key can be configured to encrypt IPMI traffic, enhancing the security of out-of-band management. The key is a write-only, encrypted property.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the IPMI settings to the assigned physical server.", "x-allOf-name": "ipmioverlan.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'ipmioverlan.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ipmioverlan.PolicyInventory" ], "default": "ipmioverlan.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ipmioverlan.PolicyInventory" ], "default": "ipmioverlan.PolicyInventory", "x-enum-as-string": true }, "Enabled": { "description": "State of the IPMI Over LAN service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "EncryptionKey": { "description": "The encryption key to use for IPMI communication. It should have an even number of hexadecimal characters and not exceed 40 characters. Use \u201c00\u201d to disable encryption key use. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. IPMI commands using this key should append zeroes to the key to achieve a length of 40 characters.", "type": "string", "pattern": "^[a-fA-F0-9]*$", "minLength": 0, "maxLength": 40, "writeOnly": true, "x-omitempty": true }, "IsEncryptionKeySet": { "description": "Indicates whether the value of the 'encryptionKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Privilege": { "description": "The highest privilege level that can be assigned to an IPMI session on a server. This configuration is supported by all Standalone C-Series servers. FI-attached C-Series servers with firmware at minimum of 4.2.3a support this configuration. B/X-Series servers with firmware at minimum of 5.1.0.x support this configuration. Privilege level user is not supported for B/X-Series servers.\n* `admin` - Privilege to perform all actions available through IPMI.\n* `user` - Privilege to perform some functions through IPMI but restriction on performing administrative tasks.\n* `read-only` - Privilege to view information throught IPMI but restriction on making any changes.", "type": "string", "enum": [ "admin", "user", "read-only" ], "default": "admin", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ipmioverlan.PolicyInventory.List": { "title": "List of 'ipmioverlan.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ipmioverlan.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ipmioverlan.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ipmioverlan.PolicyInventory" }, "nullable": true } } } ] }, "ippool.BlockLease.Response": { "description": "The response body of a HTTP GET request for the 'ippool.BlockLease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.BlockLease' resources.", "x-one-of-name": "ippool.BlockLease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.BlockLease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.BlockLease.Relationship": { "description": "A relationship to the 'ippool.BlockLease' resource, or the expanded 'ippool.BlockLease' resource, or the 'null' value.", "x-one-of-name": "ippool.BlockLease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.BlockLease" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.BlockLease": { "title": "Ippool:Block Lease", "description": "BlockLease represents an IP address that is allocated from a pool to a specific entity like server profile.", "x-allOf-name": "ippool.BlockLease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.BlockLease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.BlockLease" ], "default": "ippool.BlockLease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.BlockLease" ], "default": "ippool.BlockLease", "x-enum-as-string": true }, "IpType": { "description": "Type of the IP address requested.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IpLeases": { "description": "An array of relationships to ippoolIpLease resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.IpLease.Relationship" }, "nullable": true }, "Pool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Universe": { "$ref": "#/components/schemas/ippool.Universe.Relationship", "description": "A reference to a ippoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "ippool.BlockLease.List": { "title": "List of 'ippool.BlockLease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.BlockLease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.BlockLease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.BlockLease" }, "nullable": true } } } ] }, "ippool.IpLease.Response": { "description": "The response body of a HTTP GET request for the 'ippool.IpLease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.IpLease' resources.", "x-one-of-name": "ippool.IpLease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.IpLease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.IpLease.Relationship": { "description": "A relationship to the 'ippool.IpLease' resource, or the expanded 'ippool.IpLease' resource, or the 'null' value.", "x-one-of-name": "ippool.IpLease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.IpLease" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.IpLease": { "title": "Ippool:Ip Lease", "description": "IpLease represents an IP address that is allocated from a pool to a specific entity like server profile.", "x-allOf-name": "ippool.IpLease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.IpLease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.IpLease" ], "default": "ippool.IpLease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.IpLease" ], "default": "ippool.IpLease", "x-enum-as-string": true }, "IpType": { "description": "Type of the IP address requested.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-createOnly": true, "x-omitempty": true }, "IpV4Address": { "description": "IPv4 Address given as a lease to an external entity like server profiles.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-createOnly": true, "x-omitempty": true }, "IpV4Config": { "description": "Netmask, Gateway and DNS settings for IPv4 addresses.", "$ref": "#/components/schemas/ippool.IpV4Config", "x-createOnly": true, "x-omitempty": true }, "IpV6Address": { "description": "IPv6 Address given as a lease to an external entity like server profiles.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-createOnly": true, "x-omitempty": true }, "IpV6Config": { "description": "Netmask, Gateway and DNS settings for IPv6 addresses.", "$ref": "#/components/schemas/ippool.IpV6Config", "x-createOnly": true, "x-omitempty": true }, "PreferredIpV4Address": { "description": "The preferred IPv4 address can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that IPv4 address if it is available in the pool. If the specified preferred IPv4 address is not in the range of the pool or if it is already leased or reserved, then the next available IPv4 address from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred IPv4 address property. When the preferred IPv4 address property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration also supported only for dynamic lease requests.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-createOnly": true, "x-omitempty": true }, "PreferredIpV6Address": { "description": "The preferred IPv6 address can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that IPv6 address if it is available in the pool. If the specified preferred IPv6 address is not in the range of the pool or if it is already leased or reserved, then the next available IPv6 address from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred IPv6 address property. When the preferred IPv6 address property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration also supported only for dynamic lease requests.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-createOnly": true, "x-omitempty": true }, "Reservation": { "description": "The holder of a reference to reservation Moid and the specific details on lease condition for this reservation. Specified to allocate already reserved identities.", "$ref": "#/components/schemas/ippool.ReservationReference", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BlockLease": { "$ref": "#/components/schemas/ippool.BlockLease.Relationship", "description": "A reference to a ippoolBlockLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Pool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/ippool.PoolMember.Relationship", "description": "A reference to a ippoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/ippool.Universe.Relationship", "description": "A reference to a ippoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "ippool.IpLease.List": { "title": "List of 'ippool.IpLease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.IpLease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.IpLease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.IpLease" }, "nullable": true } } } ] }, "ippool.IpV4Block": { "title": "Ippool:Ip V4 Block", "description": "A block of IPv4 addresses.", "x-allOf-name": "ippool.IpV4Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.IpV4Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.IpV4Block" ], "default": "ippool.IpV4Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.IpV4Block" ], "default": "ippool.IpV4Block", "x-enum-as-string": true }, "From": { "description": "First IPv4 address of the block.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "IdMappingPolicyMoid": { "description": "The managed object ID of the ID mapping policy.", "type": "string", "x-omitempty": true }, "IpV4Config": { "description": "Netmask, Gateway and DNS settings for IPv4 addresses.", "$ref": "#/components/schemas/ippool.IpV4Config", "x-omitempty": true }, "To": { "description": "Last IPv4 address of the block.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true } } } ] }, "ippool.IpV4Config": { "title": "Ippool:Ip V4 Config", "description": "Network interface configuration data for IPv4 interfaces. Netmask, Gateway and DNS settings.", "x-allOf-name": "ippool.IpV4Config", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.IpV4Config', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.IpV4Config" ], "default": "ippool.IpV4Config", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.IpV4Config" ], "default": "ippool.IpV4Config", "x-enum-as-string": true }, "Gateway": { "description": "IP address of the default IPv4 gateway.", "type": "string", "pattern": "^$|^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "Netmask": { "description": "A subnet mask is a 32-bit number that masks an IP address and divides the IP address into network address and host address.", "type": "string", "pattern": "^$|^(((255\\.){3}(255|254|252|248|240|224|192|128|0+))|((255\\.){2}(255|254|252|248|240|224|192|128|0+)\\.0)|((255\\.)(255|254|252|248|240|224|192|128|0+)(\\.0+){2})|((255|254|252|248|240|224|192|128|0+)(\\.0+){3}))$", "x-omitempty": true }, "PrimaryDns": { "description": "IP Address of the primary Domain Name System (DNS) server.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "SecondaryDns": { "description": "IP Address of the secondary Domain Name System (DNS) server.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true } } } ] }, "ippool.IpV6Block": { "title": "Ippool:Ip V6 Block", "description": "A block of IPv6 addresses.", "x-allOf-name": "ippool.IpV6Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.IpV6Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.IpV6Block" ], "default": "ippool.IpV6Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.IpV6Block" ], "default": "ippool.IpV6Block", "x-enum-as-string": true }, "From": { "description": "First IPv6 address of the block.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "IdMappingPolicyMoid": { "description": "The managed object ID of the ID mapping policy.", "type": "string", "x-omitempty": true }, "IpV6Config": { "description": "Netmask, Gateway and DNS settings for IPv6 addresses.", "$ref": "#/components/schemas/ippool.IpV6Config", "x-omitempty": true }, "To": { "description": "Last IPv6 address of the block.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true } } } ] }, "ippool.IpV6Config": { "title": "Ippool:Ip V6 Config", "description": "Network interface configuration data for IPv6 interfaces. Netmask, Gateway and DNS settings.", "x-allOf-name": "ippool.IpV6Config", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.IpV6Config', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.IpV6Config" ], "default": "ippool.IpV6Config", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.IpV6Config" ], "default": "ippool.IpV6Config", "x-enum-as-string": true }, "Gateway": { "description": "IP address of the default IPv6 gateway.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "Prefix": { "description": "A prefix length which masks the IP address and divides the IP address into network address and host address.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 127, "x-omitempty": true }, "PrimaryDns": { "description": "IP Address of the primary Domain Name System (DNS) server.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "SecondaryDns": { "description": "IP Address of the secondary Domain Name System (DNS) server.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true } } } ] }, "ippool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'ippool.Pool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.Pool' resources.", "x-one-of-name": "ippool.Pool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.Pool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.Pool.Relationship": { "description": "A relationship to the 'ippool.Pool' resource, or the expanded 'ippool.Pool' resource, or the 'null' value.", "x-one-of-name": "ippool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.Pool": { "title": "Ippool:Pool", "description": "Pool represents a collection of IPv4 and/or IPv6 addresses that can be allocated to other configuration entities like server profiles.", "x-allOf-name": "ippool.Pool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.Pool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.Pool" ], "default": "ippool.Pool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.Pool" ], "default": "ippool.Pool", "x-enum-as-string": true }, "EnableBlockLevelSubnetConfig": { "description": "Enables subnet configuration at the block level.", "type": "boolean", "x-omitempty": true }, "IpV4Blocks": { "type": "array", "items": { "description": "Collection of IPv4 blocks.", "$ref": "#/components/schemas/ippool.IpV4Block", "x-omitempty": true }, "nullable": true }, "IpV4Config": { "description": "Netmask, Gateway and DNS settings for IPv4 addresses.", "$ref": "#/components/schemas/ippool.IpV4Config", "x-omitempty": true }, "IpV6Blocks": { "type": "array", "items": { "description": "Collection of IPv6 blocks.", "$ref": "#/components/schemas/ippool.IpV6Block", "x-omitempty": true }, "nullable": true }, "IpV6Config": { "description": "Netmask, Gateway and DNS settings for IPv6 addresses.", "$ref": "#/components/schemas/ippool.IpV6Config", "x-omitempty": true }, "V4Assigned": { "description": "Number of IPv4 addresses currently in use.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V4Size": { "description": "Number of IPv4 addresses in this pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V6Assigned": { "description": "Number of IPv6 addresses currently in use.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V6Size": { "description": "Number of IPv6 addresses in this pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Reservations": { "description": "An array of relationships to ippoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Reservation.Relationship" }, "nullable": true }, "ShadowPools": { "description": "An array of relationships to ippoolShadowPool resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.ShadowPool.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "ippool.Pool.List": { "title": "List of 'ippool.Pool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.Pool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Pool" }, "nullable": true } } } ] }, "ippool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'ippool.PoolMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.PoolMember' resources.", "x-one-of-name": "ippool.PoolMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.PoolMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.PoolMember.Relationship": { "description": "A relationship to the 'ippool.PoolMember' resource, or the expanded 'ippool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "ippool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.PoolMember": { "title": "Ippool:Pool Member", "description": "PoolMember represents a single IPv4 and or IPv6 address that is part of a pool.", "x-allOf-name": "ippool.PoolMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractIdPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.PoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.PoolMember" ], "default": "ippool.PoolMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.PoolMember" ], "default": "ippool.PoolMember", "x-enum-as-string": true }, "IpType": { "description": "Type of the IP address requested.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "readOnly": true, "x-omitempty": true }, "IpV4Address": { "description": "IPv4 Address of this pool member.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "IpV6Address": { "description": "IPv6 Address of this pool member.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IpBlock": { "$ref": "#/components/schemas/ippool.ShadowBlock.Relationship", "description": "A reference to a ippoolShadowBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Peer": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/components/schemas/ippool.ShadowPool.Relationship", "description": "A reference to a ippoolShadowPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/ippool.Reservation.Relationship", "description": "A reference to a ippoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ippool.PoolMember.List": { "title": "List of 'ippool.PoolMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.PoolMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.PoolMember" }, "nullable": true } } } ] }, "ippool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'ippool.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.Reservation' resources.", "x-one-of-name": "ippool.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.Reservation.Relationship": { "description": "A relationship to the 'ippool.Reservation' resource, or the expanded 'ippool.Reservation' resource, or the 'null' value.", "x-one-of-name": "ippool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.Reservation": { "title": "Ippool:Reservation", "description": "The IP reservation object, used to hold reserved addresses.", "x-allOf-name": "ippool.Reservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.Reservation" ], "default": "ippool.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.Reservation" ], "default": "ippool.Reservation", "x-enum-as-string": true }, "Identity": { "description": "IP identity to be reserved.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "IpType": { "description": "Type of the IP address that needs to be reserved.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-createOnly": true, "x-omitempty": true }, "IpV4Address": { "description": "IPv4 Address to be reserved.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "IpV6Address": { "description": "IPv6 Address to be reserved.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "VrfMoid": { "description": "The moid of the Virtual Routing and Forwarding MO.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "BlockHead": { "$ref": "#/components/schemas/ippool.ShadowBlock.Relationship", "description": "A reference to a ippoolShadowBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Pool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/ippool.PoolMember.Relationship", "description": "A reference to a ippoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ShadowPool": { "$ref": "#/components/schemas/ippool.ShadowPool.Relationship", "description": "A reference to a ippoolShadowPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/ippool.Universe.Relationship", "description": "A reference to a ippoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ippool.Reservation.List": { "title": "List of 'ippool.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Reservation" }, "nullable": true } } } ] }, "ippool.ReservationReference": { "title": "Ippool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "ippool.ReservationReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.ReservationReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.ReservationReference" ], "default": "ippool.ReservationReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.ReservationReference" ], "default": "ippool.ReservationReference", "x-enum-as-string": true }, "ConsumerName": { "description": "The consumer name for which the reserved IP would be used.", "type": "string", "x-omitempty": true }, "ConsumerType": { "description": "The consumer type for which the reserved IP would be used.\n* `OutofbandIpv4-Access` - IP reservation would be used for out of band management.\n* `InbandIpv4-Access` - IP reservation would be used for inband management.\n* `InbandIpv6-Access` - IP reservation would be used for inband management.\n* `ISCSI` - IP reservation would be used for ISCSI management.", "type": "string", "enum": [ "OutofbandIpv4-Access", "InbandIpv4-Access", "InbandIpv6-Access", "ISCSI" ], "default": "OutofbandIpv4-Access", "x-omitempty": true } } } ] }, "ippool.ShadowBlock.Response": { "description": "The response body of a HTTP GET request for the 'ippool.ShadowBlock' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.ShadowBlock' resources.", "x-one-of-name": "ippool.ShadowBlock.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.ShadowBlock.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.ShadowBlock.Relationship": { "description": "A relationship to the 'ippool.ShadowBlock' resource, or the expanded 'ippool.ShadowBlock' resource, or the 'null' value.", "x-one-of-name": "ippool.ShadowBlock.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.ShadowBlock" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.ShadowBlock": { "title": "Ippool:Shadow Block", "description": "A block of Contiguous IP addresses that are part of a shadow pool.", "x-allOf-name": "ippool.ShadowBlock", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlock" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.ShadowBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.ShadowBlock" ], "default": "ippool.ShadowBlock", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.ShadowBlock" ], "default": "ippool.ShadowBlock", "x-enum-as-string": true }, "IpType": { "description": "Type of this IP addresses blocks.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-omitempty": true }, "IpV4Block": { "description": "A Block of IPv4 addresses.", "$ref": "#/components/schemas/ippool.IpV4Block", "x-omitempty": true }, "IpV6Block": { "description": "A Block of IPv6 addresses.", "$ref": "#/components/schemas/ippool.IpV6Block", "x-omitempty": true }, "Pool": { "$ref": "#/components/schemas/ippool.ShadowPool.Relationship", "description": "A reference to a ippoolShadowPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to ippoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Reservation.Relationship" }, "nullable": true, "readOnly": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ippool.ShadowBlock.List": { "title": "List of 'ippool.ShadowBlock' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.ShadowBlock' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.ShadowBlock' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.ShadowBlock" }, "nullable": true } } } ] }, "ippool.ShadowPool.Response": { "description": "The response body of a HTTP GET request for the 'ippool.ShadowPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.ShadowPool' resources.", "x-one-of-name": "ippool.ShadowPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.ShadowPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.ShadowPool.Relationship": { "description": "A relationship to the 'ippool.ShadowPool' resource, or the expanded 'ippool.ShadowPool' resource, or the 'null' value.", "x-one-of-name": "ippool.ShadowPool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.ShadowPool" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.ShadowPool": { "title": "Ippool:Shadow Pool", "description": "Shadow Pool is a tracking object created on behalf of an IP pool, for each VRF.", "x-allOf-name": "ippool.ShadowPool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.ShadowPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.ShadowPool" ], "default": "ippool.ShadowPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.ShadowPool" ], "default": "ippool.ShadowPool", "x-enum-as-string": true }, "IpV4Blocks": { "type": "array", "items": { "description": "Collection of IPv4 Blocks.", "$ref": "#/components/schemas/ippool.IpV4Block", "x-omitempty": true }, "nullable": true }, "IpV4Config": { "description": "Netmask, Gateway and DNS settings for IPv4 addresses.", "$ref": "#/components/schemas/ippool.IpV4Config", "x-omitempty": true }, "IpV6Blocks": { "type": "array", "items": { "description": "Collection of IPv6 blocks.", "$ref": "#/components/schemas/ippool.IpV6Block", "x-omitempty": true }, "nullable": true }, "IpV6Config": { "description": "Netmask, Gateway and DNS settings for IPv6 addresses.", "$ref": "#/components/schemas/ippool.IpV6Config", "x-omitempty": true }, "V4Assigned": { "description": "Number of IPv4 addresses currently in use.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V4Size": { "description": "Number of IPv4 addresses in this pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V6Assigned": { "description": "Number of IPv6 addresses currently in use.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "V6Size": { "description": "Number of IPv6 addresses in this pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IpBlockHeads": { "description": "An array of relationships to ippoolShadowBlock resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.ShadowBlock.Relationship" }, "nullable": true, "readOnly": true }, "Pool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to ippoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Reservation.Relationship" }, "nullable": true, "readOnly": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ippool.ShadowPool.List": { "title": "List of 'ippool.ShadowPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.ShadowPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.ShadowPool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.ShadowPool" }, "nullable": true } } } ] }, "ippool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'ippool.Universe' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ippool.Universe' resources.", "x-one-of-name": "ippool.Universe.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ippool.Universe.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ippool.Universe.Relationship": { "description": "A relationship to the 'ippool.Universe' resource, or the expanded 'ippool.Universe' resource, or the 'null' value.", "x-one-of-name": "ippool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ippool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "ippool.Universe": { "title": "Ippool:Universe", "description": "Universe represents a book keeping container to keep track of all IP Addresses for a given VRF.", "x-allOf-name": "ippool.Universe", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'ippool.Universe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ippool.Universe" ], "default": "ippool.Universe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ippool.Universe" ], "default": "ippool.Universe", "x-enum-as-string": true }, "Vrf": { "$ref": "#/components/schemas/vrf.Vrf.Relationship", "description": "A reference to a vrfVrf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ippool.Universe.List": { "title": "List of 'ippool.Universe' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ippool.Universe' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ippool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ippool.Universe" }, "nullable": true } } } ] }, "iqnpool.Block.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.Block' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.Block' resources.", "x-one-of-name": "iqnpool.Block.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.Block.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.Block.Relationship": { "description": "A relationship to the 'iqnpool.Block' resource, or the expanded 'iqnpool.Block' resource, or the 'null' value.", "x-one-of-name": "iqnpool.Block.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.Block" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.Block": { "title": "Iqnpool:Block", "description": "A block of contiguous IQNs that are part of a pool.", "x-allOf-name": "iqnpool.Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlock" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.Block" ], "default": "iqnpool.Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.Block" ], "default": "iqnpool.Block", "x-enum-as-string": true }, "IqnSuffixBlock": { "description": "A Block of IQN suffix Addresses.", "$ref": "#/components/schemas/iqnpool.IqnSuffixBlock", "x-omitempty": true }, "Prefix": { "description": "Prefix of the IQN pool. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to iqnpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Reservation.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "iqnpool.Block.List": { "title": "List of 'iqnpool.Block' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.Block' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.Block' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Block" }, "nullable": true } } } ] }, "iqnpool.IqnSuffixBlock": { "title": "Iqnpool:Iqn Suffix Block", "description": "The suffix block of iSCSI Qualified Names (IQNs).", "x-allOf-name": "iqnpool.IqnSuffixBlock", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.IqnSuffixBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.IqnSuffixBlock" ], "default": "iqnpool.IqnSuffixBlock", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.IqnSuffixBlock" ], "default": "iqnpool.IqnSuffixBlock", "x-enum-as-string": true }, "From": { "description": "The first suffix number in the block.", "type": "integer", "format": "int64", "minimum": 0, "x-omitempty": true }, "Suffix": { "description": "The suffix for this block of IQNs.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "To": { "description": "The last suffix number in the block.", "type": "integer", "format": "int64", "x-omitempty": true } } } ] }, "iqnpool.Lease.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.Lease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.Lease' resources.", "x-one-of-name": "iqnpool.Lease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.Lease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.Lease.Relationship": { "description": "A relationship to the 'iqnpool.Lease' resource, or the expanded 'iqnpool.Lease' resource, or the 'null' value.", "x-one-of-name": "iqnpool.Lease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.Lease" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.Lease": { "title": "Iqnpool:Lease", "description": "Lease represents a single IQN address that is part of the universe, allocated either from a pool or through static assignment.", "x-allOf-name": "iqnpool.Lease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.Lease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.Lease" ], "default": "iqnpool.Lease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.Lease" ], "default": "iqnpool.Lease", "x-enum-as-string": true }, "IqnAddress": { "description": "IQN address allocated for pool-based allocation. It is constructed as ::.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "x-createOnly": true, "x-omitempty": true }, "IqnNumber": { "description": "Number of the IQN address. IQN Address is constructed as ::.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IqnPrefix": { "description": "Prefix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "IqnSuffix": { "description": "Suffix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreferredIqnAddress": { "description": "The preferred IQN address can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that IQN address if it is available in the pool. If the specified preferred IQN address is not in the range of the pool or if it is already leased or reserved, then the next available IQN address from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred IQN address property. When the preferred IQN address property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration is supported only for dynamic lease requests.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "x-createOnly": true, "x-omitempty": true }, "Reservation": { "description": "The holder of a reference to reservation Moid and the specific details on lease condition for this reservation. Specified to allocate already reserved identities.", "$ref": "#/components/schemas/iqnpool.ReservationReference", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Pool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/iqnpool.PoolMember.Relationship", "description": "A reference to a iqnpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/iqnpool.Universe.Relationship", "description": "A reference to a iqnpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iqnpool.Lease.List": { "title": "List of 'iqnpool.Lease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.Lease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.Lease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Lease" }, "nullable": true } } } ] }, "iqnpool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.Pool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.Pool' resources.", "x-one-of-name": "iqnpool.Pool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.Pool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.Pool.Relationship": { "description": "A relationship to the 'iqnpool.Pool' resource, or the expanded 'iqnpool.Pool' resource, or the 'null' value.", "x-one-of-name": "iqnpool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.Pool": { "title": "Iqnpool:Pool", "description": "Pool represents a collection of iSCSI Qualified Names (IQNs) for use as initiator identifiers by iSCSI vNICs.", "x-allOf-name": "iqnpool.Pool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.Pool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.Pool" ], "default": "iqnpool.Pool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.Pool" ], "default": "iqnpool.Pool", "x-enum-as-string": true }, "IqnSuffixBlocks": { "type": "array", "items": { "description": "Collection of IQN blocks.", "$ref": "#/components/schemas/iqnpool.IqnSuffixBlock", "x-omitempty": true }, "nullable": true }, "Prefix": { "description": "The prefix for any IQN blocks created for this pool. IQN Prefix must have the following format \"iqn.yyyy-mm.naming-authority\", where naming-authority is usually the reverse syntax of the Internet domain name of the naming authority.", "type": "string", "x-omitempty": true }, "BlockHeads": { "description": "An array of relationships to iqnpoolBlock resources.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Block.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Reservations": { "description": "An array of relationships to iqnpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Reservation.Relationship" }, "nullable": true } } } ] }, "iqnpool.Pool.List": { "title": "List of 'iqnpool.Pool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.Pool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Pool" }, "nullable": true } } } ] }, "iqnpool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.PoolMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.PoolMember' resources.", "x-one-of-name": "iqnpool.PoolMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.PoolMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.PoolMember.Relationship": { "description": "A relationship to the 'iqnpool.PoolMember' resource, or the expanded 'iqnpool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "iqnpool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.PoolMember": { "title": "Iqnpool:Pool Member", "description": "PoolMember represents a single IQN address that is part of a pool.", "x-allOf-name": "iqnpool.PoolMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractIdPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.PoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.PoolMember" ], "default": "iqnpool.PoolMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.PoolMember" ], "default": "iqnpool.PoolMember", "x-enum-as-string": true }, "IqnAddress": { "description": "IQN Address of this pool member. It is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "IqnNumber": { "description": "Number of the IQN address. IQN Address is constructed as ::.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IqnPrefix": { "description": "Prefix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "IqnSuffix": { "description": "Suffix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BlockHead": { "$ref": "#/components/schemas/iqnpool.Block.Relationship", "description": "A reference to a iqnpoolBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Peer": { "$ref": "#/components/schemas/iqnpool.Lease.Relationship", "description": "A reference to a iqnpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/iqnpool.Reservation.Relationship", "description": "A reference to a iqnpoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iqnpool.PoolMember.List": { "title": "List of 'iqnpool.PoolMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.PoolMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.PoolMember" }, "nullable": true } } } ] }, "iqnpool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.Reservation' resources.", "x-one-of-name": "iqnpool.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.Reservation.Relationship": { "description": "A relationship to the 'iqnpool.Reservation' resource, or the expanded 'iqnpool.Reservation' resource, or the 'null' value.", "x-one-of-name": "iqnpool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.Reservation": { "title": "Iqnpool:Reservation", "description": "The IQN reservation object, used to hold reserved identity.", "x-allOf-name": "iqnpool.Reservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.Reservation" ], "default": "iqnpool.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.Reservation" ], "default": "iqnpool.Reservation", "x-enum-as-string": true }, "Identity": { "description": "IQN identity to be reserved.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "x-createOnly": true, "x-omitempty": true }, "IqnNumber": { "description": "Number of the IQN address. IQN Address is constructed as ::.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IqnPrefix": { "description": "Prefix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "IqnSuffix": { "description": "Suffix of the IQN address. IQN Address is constructed as ::.", "type": "string", "readOnly": true, "x-omitempty": true }, "Block": { "$ref": "#/components/schemas/iqnpool.Block.Relationship", "description": "A reference to a iqnpoolBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Pool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/iqnpool.PoolMember.Relationship", "description": "A reference to a iqnpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/iqnpool.Universe.Relationship", "description": "A reference to a iqnpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iqnpool.Reservation.List": { "title": "List of 'iqnpool.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Reservation" }, "nullable": true } } } ] }, "iqnpool.ReservationReference": { "title": "Iqnpool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "iqnpool.ReservationReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference" } ] }, "iqnpool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'iqnpool.Universe' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'iqnpool.Universe' resources.", "x-one-of-name": "iqnpool.Universe.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/iqnpool.Universe.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "iqnpool.Universe.Relationship": { "description": "A relationship to the 'iqnpool.Universe' resource, or the expanded 'iqnpool.Universe' resource, or the 'null' value.", "x-one-of-name": "iqnpool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/iqnpool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "iqnpool.Universe": { "title": "Iqnpool:Universe", "description": "Universe represents a book keeping container to keep track of all IDs for a given account and pool type.", "x-allOf-name": "iqnpool.Universe", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'iqnpool.Universe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "iqnpool.Universe" ], "default": "iqnpool.Universe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "iqnpool.Universe" ], "default": "iqnpool.Universe", "x-enum-as-string": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "iqnpool.Universe.List": { "title": "List of 'iqnpool.Universe' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'iqnpool.Universe' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'iqnpool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/iqnpool.Universe" }, "nullable": true } } } ] }, "kvm.Policy.Response": { "description": "The response body of a HTTP GET request for the 'kvm.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'kvm.Policy' resources.", "x-one-of-name": "kvm.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/kvm.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "kvm.Policy": { "title": "Virtual KVM", "description": "The Virtual KVM Policy is a reusable policy used to configure the virtual Keyboard, Video, and Mouse (KVM) settings for a server.\n#### Purpose\nThe purpose of this policy is to standardize and control remote console access to servers. It allows administrators to manage the vKVM service, define the number of concurrent sessions, configure network ports, and enforce encryption for secure remote management.\n#### Key Concepts\n- **Service Control:** The policy enables or disables the vKVM service on the endpoint.\n- **Session Management:** It allows administrators to set the maximum number of concurrent vKVM sessions, helping to manage resources and access.\n- **Security:** The policy can enforce encryption for all video information sent through the KVM, securing the remote console session.\n- **Tunneled KVM:** Supports enabling Tunneled vKVM, which allows secure KVM access through the Intersight platform without requiring direct network access to the server's management IP.\n- **Profile-Based Application:** It is attached to a Server Profile to apply the vKVM settings to the assigned physical server.", "x-allOf-name": "kvm.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'kvm.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "kvm.Policy" ], "default": "kvm.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "kvm.Policy" ], "default": "kvm.Policy", "x-enum-as-string": true }, "EnableLocalServerVideo": { "description": "If enabled, displays KVM session on any monitor attached to the server.", "type": "boolean", "default": true, "x-omitempty": true }, "EnableVideoEncryption": { "description": "If enabled, encrypts all video information sent through KVM. Please note that this can no longer be disabled for servers running versions 4.2 and above.", "type": "boolean", "default": true, "x-omitempty": true }, "Enabled": { "description": "State of the vKVM service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "MaximumSessions": { "description": "The maximum number of concurrent KVM sessions allowed.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 4, "x-omitempty": true }, "RemotePort": { "description": "The port used for KVM communication.", "type": "integer", "format": "int64", "default": 2068, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "TunneledKvmEnabled": { "description": "Enables Tunneled vKVM on the endpoint. Applicable only for Device Connectors that support Tunneled vKVM.", "type": "boolean", "default": false, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "kvm.Policy.List": { "title": "List of 'kvm.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'kvm.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'kvm.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/kvm.Policy" }, "nullable": true } } } ] }, "kvm.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'kvm.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'kvm.PolicyInventory' resources.", "x-one-of-name": "kvm.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/kvm.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "kvm.PolicyInventory": { "title": "Virtual KVM", "description": "The Virtual KVM Policy is a reusable policy used to configure the virtual Keyboard, Video, and Mouse (KVM) settings for a server.\n#### Purpose\nThe purpose of this policy is to standardize and control remote console access to servers. It allows administrators to manage the vKVM service, define the number of concurrent sessions, configure network ports, and enforce encryption for secure remote management.\n#### Key Concepts\n- **Service Control:** The policy enables or disables the vKVM service on the endpoint.\n- **Session Management:** It allows administrators to set the maximum number of concurrent vKVM sessions, helping to manage resources and access.\n- **Security:** The policy can enforce encryption for all video information sent through the KVM, securing the remote console session.\n- **Tunneled KVM:** Supports enabling Tunneled vKVM, which allows secure KVM access through the Intersight platform without requiring direct network access to the server's management IP.\n- **Profile-Based Application:** It is attached to a Server Profile to apply the vKVM settings to the assigned physical server.", "x-allOf-name": "kvm.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'kvm.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "kvm.PolicyInventory" ], "default": "kvm.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "kvm.PolicyInventory" ], "default": "kvm.PolicyInventory", "x-enum-as-string": true }, "EnableLocalServerVideo": { "description": "If enabled, displays KVM session on any monitor attached to the server.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "EnableVideoEncryption": { "description": "If enabled, encrypts all video information sent through KVM. Please note that this can no longer be disabled for servers running versions 4.2 and above.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "State of the vKVM service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "MaximumSessions": { "description": "The maximum number of concurrent KVM sessions allowed.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 4, "readOnly": true, "x-omitempty": true }, "RemotePort": { "description": "The port used for KVM communication.", "type": "integer", "format": "int64", "default": 2068, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "TunneledKvmEnabled": { "description": "Enables Tunneled vKVM on the endpoint. Applicable only for Device Connectors that support Tunneled vKVM.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "kvm.PolicyInventory.List": { "title": "List of 'kvm.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'kvm.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'kvm.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/kvm.PolicyInventory" }, "nullable": true } } } ] }, "kvm.Session.Response": { "description": "The response body of a HTTP GET request for the 'kvm.Session' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'kvm.Session' resources.", "x-one-of-name": "kvm.Session.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/kvm.Session.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "kvm.Session.Relationship": { "description": "A relationship to the 'kvm.Session' resource, or the expanded 'kvm.Session' resource, or the 'null' value.", "x-one-of-name": "kvm.Session.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/kvm.Session" } ], "discriminator": { "propertyName": "ClassId" } }, "kvm.Session": { "title": "Kvm:Session", "description": "Virtual KVM Session that provides Single Sign-On access to the vKVM console of the server. The vKVM access can be direct or can be tunneled by specifying the tunnel to be used for the access.", "x-allOf-name": "kvm.Session", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/session.AbstractSubSession" }, { "type": "object", "description": "Definition of the list of properties defined in 'kvm.Session', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "kvm.Session" ], "default": "kvm.Session", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "kvm.Session" ], "default": "kvm.Session", "x-enum-as-string": true }, "KvmLaunchUrlPath": { "description": "One time URL that is used to launch the vKVM console.", "type": "string", "x-omitempty": true }, "KvmSessionId": { "description": "Unique ID of the KVM Session URI.", "type": "string", "x-omitempty": true }, "OneTimePassword": { "description": "Temporary one-time password for vKVM access.", "type": "string", "x-omitempty": true }, "SsoSupported": { "description": "Indicates if vKVM SSO is supported on the server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Username": { "description": "Username used for vKVM access.", "type": "string", "x-omitempty": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Tunnel": { "$ref": "#/components/schemas/kvm.Tunnel.Relationship", "description": "A reference to a kvmTunnel resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "kvm.Session.List": { "title": "List of 'kvm.Session' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'kvm.Session' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'kvm.Session' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/kvm.Session" }, "nullable": true } } } ] }, "kvm.Tunnel.Response": { "description": "The response body of a HTTP GET request for the 'kvm.Tunnel' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'kvm.Tunnel' resources.", "x-one-of-name": "kvm.Tunnel.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/kvm.Tunnel.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "kvm.Tunnel.Relationship": { "description": "A relationship to the 'kvm.Tunnel' resource, or the expanded 'kvm.Tunnel' resource, or the 'null' value.", "x-one-of-name": "kvm.Tunnel.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/kvm.Tunnel" } ], "discriminator": { "propertyName": "ClassId" } }, "kvm.Tunnel": { "title": "Kvm:Tunnel", "description": "The Tunnel object provides tunneled virtual KVM access for server, enhancing security and flexibility. It supports the creation and management of tunnels for efficient server access.\n#### Purpose\nTunnel object facilitates secure and flexible access to server through tunneled virtual KVM connections. It enhances server management operations by providing robust and secure access mechanisms.\n#### Key Concepts\n- **Tunneled Access:** Supports tunneled virtual KVM access to server consoles, enhancing security and flexibility.\n- **Connection Management:** Manages the creation and maintenance of tunnels, ensuring efficient server access.", "x-allOf-name": "kvm.Tunnel", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/tunneling.Tunnel" }, { "type": "object", "description": "Definition of the list of properties defined in 'kvm.Tunnel', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "kvm.Tunnel" ], "default": "kvm.Tunnel", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "kvm.Tunnel" ], "default": "kvm.Tunnel", "x-enum-as-string": true }, "Device": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "KvmSession": { "$ref": "#/components/schemas/kvm.Session.Relationship", "description": "A reference to a kvmSession resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "kvm.Tunnel.List": { "title": "List of 'kvm.Tunnel' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'kvm.Tunnel' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'kvm.Tunnel' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/kvm.Tunnel" }, "nullable": true } } } ] }, "kvm.TunneledKvmPolicy.Response": { "description": "The response body of a HTTP GET request for the 'kvm.TunneledKvmPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'kvm.TunneledKvmPolicy' resources.", "x-one-of-name": "kvm.TunneledKvmPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "kvm.TunneledKvmPolicy": { "title": "Kvm:Tunneled Kvm Policy", "description": "The TunneledKvmPolicy object manages policies controlling tunneled vKVM access within the account. This provides configuration options for enabling or disabling tunneled access and configuration within the account.\n#### Purpose\nTunneledKvmPolicy object enables organizations to manage and control tunneled vKVM access through policy configuration. It ensures secure and efficient access by allowing account-specific configurations.\n#### Key Concepts\n- **Policy Management:** Manages policies for tunneled vKVM access, ensuring secure and efficient access operations.\n- **Configuration Options:** Provides options to enable or disable tunneled vKVM access and tunneled vKVM access configuration within the account, supporting tailored access control.", "x-allOf-name": "kvm.TunneledKvmPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'kvm.TunneledKvmPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "kvm.TunneledKvmPolicy" ], "default": "kvm.TunneledKvmPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "kvm.TunneledKvmPolicy" ], "default": "kvm.TunneledKvmPolicy", "x-enum-as-string": true }, "TunneledKvmConfiguration": { "description": "Enable or Disable configuration of tunneled KVM for a specific account.", "type": "boolean", "default": false, "x-omitempty": true }, "TunneledKvmLaunch": { "description": "Enable or Disable launching tunneled KVM for a specific account.", "type": "boolean", "default": false, "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "kvm.TunneledKvmPolicy.List": { "title": "List of 'kvm.TunneledKvmPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'kvm.TunneledKvmPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'kvm.TunneledKvmPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/kvm.TunneledKvmPolicy" }, "nullable": true } } } ] }, "ls.ServiceProfile.Response": { "description": "The response body of a HTTP GET request for the 'ls.ServiceProfile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ls.ServiceProfile' resources.", "x-one-of-name": "ls.ServiceProfile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ls.ServiceProfile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ls.ServiceProfile": { "title": "Ls:Service Profile", "description": "Logical Profile that can be associated to a physical server.", "x-allOf-name": "ls.ServiceProfile", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'ls.ServiceProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ls.ServiceProfile" ], "default": "ls.ServiceProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ls.ServiceProfile" ], "default": "ls.ServiceProfile", "x-enum-as-string": true }, "AssignState": { "description": "Assignment state of the service profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssocState": { "description": "Association state of the service profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssociatedServer": { "description": "Server to which the UCS Manager service profile is associated to.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "Configuration state of the service profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the UCS Manager service profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational state of the service profile.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ls.ServiceProfile.List": { "title": "List of 'ls.ServiceProfile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ls.ServiceProfile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ls.ServiceProfile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ls.ServiceProfile" }, "nullable": true } } } ] }, "macpool.Block": { "title": "Macpool:Block", "description": "Block of MAC identifiers.", "x-allOf-name": "macpool.Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.Block" ], "default": "macpool.Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.Block" ], "default": "macpool.Block", "x-enum-as-string": true }, "From": { "description": "Starting address of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx. To ensure uniqueness of MACs in the LAN fabric, you are strongly encouraged to use the following MAC prefix 00:25:B5:xx:xx:xx.", "type": "string", "x-omitempty": true }, "To": { "description": "Ending address of the block must be in hexadecimal format xx:xx:xx:xx:xx:xx.", "type": "string", "x-omitempty": true } } } ] }, "macpool.IdBlock.Response": { "description": "The response body of a HTTP GET request for the 'macpool.IdBlock' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.IdBlock' resources.", "x-one-of-name": "macpool.IdBlock.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.IdBlock.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.IdBlock.Relationship": { "description": "A relationship to the 'macpool.IdBlock' resource, or the expanded 'macpool.IdBlock' resource, or the 'null' value.", "x-one-of-name": "macpool.IdBlock.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.IdBlock" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.IdBlock": { "title": "Macpool:Id Block", "description": "A block of contiguous MAC addresses that are part of a pool.", "x-allOf-name": "macpool.IdBlock", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlock" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.IdBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.IdBlock" ], "default": "macpool.IdBlock", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.IdBlock" ], "default": "macpool.IdBlock", "x-enum-as-string": true }, "MacBlock": { "description": "A Block of MAC Addresses.", "$ref": "#/components/schemas/macpool.Block", "x-omitempty": true }, "Pool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to macpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Reservation.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "macpool.IdBlock.List": { "title": "List of 'macpool.IdBlock' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.IdBlock' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.IdBlock' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.IdBlock" }, "nullable": true } } } ] }, "macpool.Lease.Response": { "description": "The response body of a HTTP GET request for the 'macpool.Lease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.Lease' resources.", "x-one-of-name": "macpool.Lease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.Lease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.Lease.Relationship": { "description": "A relationship to the 'macpool.Lease' resource, or the expanded 'macpool.Lease' resource, or the 'null' value.", "x-one-of-name": "macpool.Lease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.Lease" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.Lease": { "title": "Macpool:Lease", "description": "Lease represents a single MAC address that is part of the universe, allocated either from a pool or through static assignment.", "x-allOf-name": "macpool.Lease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.Lease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.Lease" ], "default": "macpool.Lease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.Lease" ], "default": "macpool.Lease", "x-enum-as-string": true }, "MacAddress": { "description": "MAC address allocated for pool-based allocation.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "PreferredMacAddress": { "description": "The preferred MAC address can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that MAC address if it is available in the pool. If the specified preferred MAC address is not in the range of the pool or if it is already leased or reserved, then the next available MAC address from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred MAC address property. When the preferred MAC address property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration also supported only for dynamic lease requests.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Reservation": { "description": "The holder of a reference to reservation Moid and the specific details on lease condition for this reservation. Specified to allocate already reserved identities.", "$ref": "#/components/schemas/macpool.ReservationReference", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Pool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/macpool.PoolMember.Relationship", "description": "A reference to a macpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/macpool.Universe.Relationship", "description": "A reference to a macpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "macpool.Lease.List": { "title": "List of 'macpool.Lease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.Lease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.Lease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Lease" }, "nullable": true } } } ] }, "macpool.MemberOf": { "title": "Macpool:Member Of", "description": "The pool and block to which a pool member belongs to.", "x-allOf-name": "macpool.MemberOf", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.MemberOf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.MemberOf" ], "default": "macpool.MemberOf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.MemberOf" ], "default": "macpool.MemberOf", "x-enum-as-string": true }, "IdBlockMoid": { "description": "The moid of the block of a pool to which this ID belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "PoolMoid": { "description": "The moid of the pool to which this ID belongs.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "macpool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'macpool.Pool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.Pool' resources.", "x-one-of-name": "macpool.Pool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.Pool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.Pool.Relationship": { "description": "A relationship to the 'macpool.Pool' resource, or the expanded 'macpool.Pool' resource, or the 'null' value.", "x-one-of-name": "macpool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.Pool": { "title": "Macpool:Pool", "description": "Pool represents a collection of MAC addresses that can be allocated to VNICs of a server profile.", "x-allOf-name": "macpool.Pool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.Pool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.Pool" ], "default": "macpool.Pool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.Pool" ], "default": "macpool.Pool", "x-enum-as-string": true }, "MacBlocks": { "type": "array", "items": { "description": "Collection of MAC blocks.", "$ref": "#/components/schemas/macpool.Block", "x-omitempty": true }, "nullable": true }, "BlockHeads": { "description": "An array of relationships to macpoolIdBlock resources.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.IdBlock.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Reservations": { "description": "An array of relationships to macpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Reservation.Relationship" }, "nullable": true } } } ] }, "macpool.Pool.List": { "title": "List of 'macpool.Pool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.Pool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Pool" }, "nullable": true } } } ] }, "macpool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'macpool.PoolMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.PoolMember' resources.", "x-one-of-name": "macpool.PoolMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.PoolMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.PoolMember.Relationship": { "description": "A relationship to the 'macpool.PoolMember' resource, or the expanded 'macpool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "macpool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.PoolMember": { "title": "Macpool:Pool Member", "description": "PoolMember represents a single MAC address that is part of a pool.", "x-allOf-name": "macpool.PoolMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractIdPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.PoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.PoolMember" ], "default": "macpool.PoolMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.PoolMember" ], "default": "macpool.PoolMember", "x-enum-as-string": true }, "MacAddress": { "description": "MAC Address of this pool member.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BlockHead": { "$ref": "#/components/schemas/macpool.IdBlock.Relationship", "description": "A reference to a macpoolIdBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Peer": { "$ref": "#/components/schemas/macpool.Lease.Relationship", "description": "A reference to a macpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/macpool.Reservation.Relationship", "description": "A reference to a macpoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "macpool.PoolMember.List": { "title": "List of 'macpool.PoolMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.PoolMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.PoolMember" }, "nullable": true } } } ] }, "macpool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'macpool.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.Reservation' resources.", "x-one-of-name": "macpool.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.Reservation.Relationship": { "description": "A relationship to the 'macpool.Reservation' resource, or the expanded 'macpool.Reservation' resource, or the 'null' value.", "x-one-of-name": "macpool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.Reservation": { "title": "Macpool:Reservation", "description": "The MAC reservation object, used to hold reserved addresses.", "x-allOf-name": "macpool.Reservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.Reservation" ], "default": "macpool.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.Reservation" ], "default": "macpool.Reservation", "x-enum-as-string": true }, "Identity": { "description": "MAC identity to be reserved.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "MemberOf": { "type": "array", "items": { "description": "Reference to Mac pool and block MOs to which this reserved identity belongs.", "$ref": "#/components/schemas/macpool.MemberOf", "readOnly": true, "x-omitempty": true }, "nullable": true }, "BlockHead": { "$ref": "#/components/schemas/macpool.IdBlock.Relationship", "description": "A reference to a macpoolIdBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Pool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/macpool.PoolMember.Relationship", "description": "A reference to a macpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/macpool.Universe.Relationship", "description": "A reference to a macpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "macpool.Reservation.List": { "title": "List of 'macpool.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Reservation" }, "nullable": true } } } ] }, "macpool.ReservationReference": { "title": "Macpool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "macpool.ReservationReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.ReservationReference', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.ReservationReference" ], "default": "macpool.ReservationReference", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.ReservationReference" ], "default": "macpool.ReservationReference", "x-enum-as-string": true }, "ConsumerName": { "description": "The consumer name for which the reserved MAC would be used.", "type": "string", "x-omitempty": true }, "ConsumerType": { "description": "The consumer type for which the reserved MAC would be used.\n* `Vnic` - MAC reservation would be used by VNIC.", "type": "string", "enum": [ "Vnic" ], "default": "Vnic", "x-omitempty": true } } } ] }, "macpool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'macpool.Universe' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'macpool.Universe' resources.", "x-one-of-name": "macpool.Universe.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/macpool.Universe.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "macpool.Universe.Relationship": { "description": "A relationship to the 'macpool.Universe' resource, or the expanded 'macpool.Universe' resource, or the 'null' value.", "x-one-of-name": "macpool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/macpool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "macpool.Universe": { "title": "Macpool:Universe", "description": "Universe represents a book keeping container to keep track of all IDs for a given account and pool type.", "x-allOf-name": "macpool.Universe", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'macpool.Universe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "macpool.Universe" ], "default": "macpool.Universe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "macpool.Universe" ], "default": "macpool.Universe", "x-enum-as-string": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "macpool.Universe.List": { "title": "List of 'macpool.Universe' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'macpool.Universe' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'macpool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/macpool.Universe" }, "nullable": true } } } ] }, "management.Controller.Response": { "description": "The response body of a HTTP GET request for the 'management.Controller' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'management.Controller' resources.", "x-one-of-name": "management.Controller.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/management.Controller.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "management.Controller.Relationship": { "description": "A relationship to the 'management.Controller' resource, or the expanded 'management.Controller' resource, or the 'null' value.", "x-one-of-name": "management.Controller.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/management.Controller" } ], "discriminator": { "propertyName": "ClassId" } }, "management.Controller": { "title": "Management:Controller", "description": "A specialized service processor that monitors the physical state of a server, using sensors and communicating with the system administrator through an independent connection.", "x-allOf-name": "management.Controller", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'management.Controller', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "management.Controller" ], "default": "management.Controller", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "management.Controller" ], "default": "management.Controller", "x-enum-as-string": true }, "Certificate": { "description": "IMC Certificate that is used for verifying the authorization.", "$ref": "#/components/schemas/certificatemanagement.Imc", "readOnly": true, "x-omitempty": true }, "KmipClientCertificate": { "description": "KMIP Client Certificate to be used in inventory.", "$ref": "#/components/schemas/certificatemanagement.Imc", "readOnly": true, "x-omitempty": true }, "Model": { "description": "Model of the endpoint that houses the management controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplayConfigInfo": { "description": "Information about config replay after a reboot of the Fabric Interconnect.", "$ref": "#/components/schemas/management.ReplayConfigInfo", "readOnly": true, "x-omitempty": true }, "RootCaCertificates": { "type": "array", "items": { "description": "A collection of Root CA Certificates that are used for verifying the authorization.", "$ref": "#/components/schemas/certificatemanagement.RootCaCertificate", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UemStreamAdminState": { "description": "Desired state of the UEM stream.\n* `Disabled` - The UEM event channel is disabled.\n* `Enabled` - The UEM event channel is enabled.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "x-omitempty": true }, "AdapterUnit": { "$ref": "#/components/schemas/adapter.Unit.Relationship", "description": "A reference to a adapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentIoCardBase": { "$ref": "#/components/schemas/equipment.IoCardBase.Relationship", "description": "A reference to a equipmentIoCardBase resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentSharedIoModule": { "$ref": "#/components/schemas/equipment.SharedIoModule.Relationship", "description": "A reference to a equipmentSharedIoModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentSystemIoController": { "$ref": "#/components/schemas/equipment.SystemIoController.Relationship", "description": "A reference to a equipmentSystemIoController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ManagementInterfaces": { "description": "An array of relationships to managementInterface resources.", "type": "array", "items": { "$ref": "#/components/schemas/management.Interface.Relationship" }, "nullable": true, "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkSecureRouter": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.SecureRouter.Relationship", "description": "A reference to a networkSecureRouter resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "StorageSasExpander": { "$ref": "#/components/schemas/storage.SasExpander.Relationship", "description": "A reference to a storageSasExpander resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TopSystem": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/top.System.Relationship", "description": "A reference to a topSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "management.Controller.List": { "title": "List of 'management.Controller' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'management.Controller' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'management.Controller' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/management.Controller" }, "nullable": true } } } ] }, "management.Entity.Response": { "description": "The response body of a HTTP GET request for the 'management.Entity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'management.Entity' resources.", "x-one-of-name": "management.Entity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/management.Entity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "management.Entity.Relationship": { "description": "A relationship to the 'management.Entity' resource, or the expanded 'management.Entity' resource, or the 'null' value.", "x-one-of-name": "management.Entity.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/management.Entity" } ], "discriminator": { "propertyName": "ClassId" } }, "management.Entity": { "title": "Management:Entity", "description": "Logical representation that captures the role of each Fabric Interconnect in UCS Manager.", "x-allOf-name": "management.Entity", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'management.Entity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "management.Entity" ], "default": "management.Entity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "management.Entity" ], "default": "management.Entity", "x-enum-as-string": true }, "ClusterLinkState": { "description": "Cluster link state between the Fabric Interconnects.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterReadiness": { "description": "Cluster readiness of the Fabric Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterState": { "description": "Cluster state of the Fabric Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "EntityId": { "description": "Identity of the Fabric Interconnect - A/B.", "type": "string", "readOnly": true, "x-omitempty": true }, "Leadership": { "description": "Role (Primary / Subordinate) of the Fabric Interconnect.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "management.Entity.List": { "title": "List of 'management.Entity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'management.Entity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'management.Entity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/management.Entity" }, "nullable": true } } } ] }, "management.Interface.Response": { "description": "The response body of a HTTP GET request for the 'management.Interface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'management.Interface' resources.", "x-one-of-name": "management.Interface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/management.Interface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "management.Interface.Relationship": { "description": "A relationship to the 'management.Interface' resource, or the expanded 'management.Interface' resource, or the 'null' value.", "x-one-of-name": "management.Interface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/management.Interface" } ], "discriminator": { "propertyName": "ClassId" } }, "management.Interface": { "title": "Management:Interface", "description": "Interface that provides access to the management controller.", "x-allOf-name": "management.Interface", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'management.Interface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "management.Interface" ], "default": "management.Interface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "management.Interface" ], "default": "management.Interface", "x-enum-as-string": true }, "Gateway": { "description": "Default gateway for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "Hostname configured for the interface.", "type": "string", "x-omitempty": true }, "IpAddress": { "description": "IP address of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4Address": { "description": "IPv4 address of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4Gateway": { "description": "IPv4 default gateway for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv4Mask": { "description": "IPv4 Netmask for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipv6Address": { "description": "IPv6 address of the interface.", "type": "string", "x-omitempty": true }, "Ipv6Gateway": { "description": "IPv6 default gateway for the interface.", "type": "string", "x-omitempty": true }, "Ipv6Prefix": { "description": "IPv6 prefix for the interface.", "type": "integer", "format": "int64", "x-omitempty": true }, "MacAddress": { "description": "MAC address configured for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mask": { "description": "Netmask for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "Switch Id connected to the interface.", "type": "string", "x-omitempty": true }, "UemConnStatus": { "description": "The event channel connection status for the interface.", "type": "string", "x-omitempty": true }, "VirtualHostName": { "description": "Virtual hostname configured for the interface in case of clustered environment.", "type": "string", "x-omitempty": true }, "VlanId": { "description": "VlanId configured for the interface.", "type": "integer", "format": "int64", "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ManagementController": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "management.Interface.List": { "title": "List of 'management.Interface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'management.Interface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'management.Interface' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/management.Interface" }, "nullable": true } } } ] }, "management.ReplayConfigInfo": { "title": "Management:Replay Config Info", "description": "Information about replay config after a reboot of the Fabric Interconnect.", "x-allOf-name": "management.ReplayConfigInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'management.ReplayConfigInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "management.ReplayConfigInfo" ], "default": "management.ReplayConfigInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "management.ReplayConfigInfo" ], "default": "management.ReplayConfigInfo", "x-enum-as-string": true }, "ReplayConfigEndTime": { "description": "Time at which replay config ended.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ReplayConfigStartTime": { "description": "Time at which replay config started.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ReplayConfigStatus": { "description": "Status of replay config of the Fabric Interconnect.\n* `Completed` - Configuration replay is complete.\n* `InProgress` - Configuration replay is in progress.\n* `TimedOut` - Configuration replay timed out.\n* `Fail` - Configuration replay failed.", "type": "string", "enum": [ "Completed", "InProgress", "TimedOut", "Fail" ], "default": "Completed", "readOnly": true, "x-omitempty": true } } } ] }, "memory.AbstractUnit": { "title": "Memory:Abstract Unit", "description": "Abstract class for all memory units.", "x-allOf-name": "memory.AbstractUnit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.AbstractUnit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "memory.PersistentMemoryUnit", "memory.Unit" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "memory.PersistentMemoryUnit", "memory.Unit" ], "x-enum-as-string": true }, "AdminState": { "description": "This represents the administrative state of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ArrayId": { "description": "This represents the memory array to which the memory unit belongs to.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Bank": { "description": "This represents the memory bank of the memory unit on a server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Capacity": { "description": "This represents the memory capacity in MiB of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Clock": { "description": "This represents the clock of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "FormFactor": { "description": "This represents the form factor of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Latency": { "description": "This represents the latency of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Location": { "description": "This represents the location of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "This represents the operational power state of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the memory unit.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "This represents the operational state of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "This represents the operability of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Set": { "description": "This represents the set of the memory unit on a server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Speed": { "description": "This represents the speed of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "This represents the thremal state of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "This represents the memory type of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Visibility": { "description": "This represents the visibility of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Width": { "description": "This represents the width of the memory unit on a server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "memory.Array.Response": { "description": "The response body of a HTTP GET request for the 'memory.Array' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.Array' resources.", "x-one-of-name": "memory.Array.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.Array.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.Array.Relationship": { "description": "A relationship to the 'memory.Array' resource, or the expanded 'memory.Array' resource, or the 'null' value.", "x-one-of-name": "memory.Array.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.Array" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.Array": { "title": "Memory:Array", "description": "Holder housing multiple memory units.", "x-allOf-name": "memory.Array", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.Array', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.Array" ], "default": "memory.Array", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.Array" ], "default": "memory.Array", "x-enum-as-string": true }, "ArrayId": { "description": "ID of the memory array on a server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CpuId": { "description": "ID of the CPU that access this memory array.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CurrentCapacity": { "description": "Current capacity of all the memory units on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ErrorCorrection": { "description": "The primary hardware error detection or correction method supported by the memory array.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaxCapacity": { "description": "Maximum capacity of all the memory units on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaxDevices": { "description": "The maximum number of slots or sockets available for memory devices in the memory array.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "The power state indicator of the memory array.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PersistentMemoryUnits": { "description": "An array of relationships to memoryPersistentMemoryUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Units": { "description": "An array of relationships to memoryUnit resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Unit.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "memory.Array.List": { "title": "List of 'memory.Array' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.Array' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.Array' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Array" }, "nullable": true } } } ] }, "memory.PersistentMemoryConfigResult.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryConfigResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryConfigResult' resources.", "x-one-of-name": "memory.PersistentMemoryConfigResult.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryConfigResult.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryConfigResult' resource, or the expanded 'memory.PersistentMemoryConfigResult' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryConfigResult.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryConfigResult": { "title": "Memory:Persistent Memory Config Result", "description": "Result of a previously applied Persistent Memory configuration on a server.", "x-allOf-name": "memory.PersistentMemoryConfigResult", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryConfigResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryConfigResult" ], "default": "memory.PersistentMemoryConfigResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryConfigResult" ], "default": "memory.PersistentMemoryConfigResult", "x-enum-as-string": true }, "ConfigErrorDesc": { "description": "Error in the result of a previously applied Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigResult": { "description": "Result of a previously applied Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigSequenceNo": { "description": "Sequence number of a previously applied Persistent Memory configuration on a server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "State of a previously applied Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryPersistentMemoryConfiguration": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration.Relationship", "description": "A reference to a memoryPersistentMemoryConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PersistentMemoryNamespaceConfigResults": { "description": "An array of relationships to memoryPersistentMemoryNamespaceConfigResult resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryConfigResult.List": { "title": "List of 'memory.PersistentMemoryConfigResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryConfigResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryConfigResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult" }, "nullable": true } } } ] }, "memory.PersistentMemoryConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryConfiguration' resources.", "x-one-of-name": "memory.PersistentMemoryConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryConfiguration.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryConfiguration' resource, or the expanded 'memory.PersistentMemoryConfiguration' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryConfiguration.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryConfiguration": { "title": "Memory:Persistent Memory Configuration", "description": "Persistent Memory configuration on all the Persistent Memory Modules on a server.", "x-allOf-name": "memory.PersistentMemoryConfiguration", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryConfiguration" ], "default": "memory.PersistentMemoryConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryConfiguration" ], "default": "memory.PersistentMemoryConfiguration", "x-enum-as-string": true }, "MemoryCapacity": { "description": "Memory capacity in GiB of a Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumOfModules": { "description": "Number of Persistent Memory Modules on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumOfRegions": { "description": "Number of Persistent Memory Regions on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PersistentMemoryCapacity": { "description": "Persistent memory capacity in GiB of a Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReservedCapacity": { "description": "Reserved capacity in GiB of a Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SecurityState": { "description": "Collective security state of all Persistent Memory modules on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalCapacity": { "description": "Total capacity in GiB of a Persistent Memory configuration on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PersistentMemoryConfigResult": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult.Relationship", "description": "A reference to a memoryPersistentMemoryConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PersistentMemoryRegions": { "description": "An array of relationships to memoryPersistentMemoryRegion resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryConfiguration.List": { "title": "List of 'memory.PersistentMemoryConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration" }, "nullable": true } } } ] }, "memory.PersistentMemoryGoal": { "title": "Persistent Memory Goal", "description": "A Persistent Memory Goal that needs to be applied on the associated servers through the policy. This would result in the creation of regions and allocation of volatile memory on the server.", "x-allOf-name": "memory.PersistentMemoryGoal", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryGoal', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryGoal" ], "default": "memory.PersistentMemoryGoal", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryGoal" ], "default": "memory.PersistentMemoryGoal", "x-enum-as-string": true }, "MemoryModePercentage": { "description": "Volatile memory percentage.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 100, "x-omitempty": true }, "PersistentMemoryType": { "description": "Type of the Persistent Memory configuration where the Persistent Memory Modules are combined in an interleaved set or not.\n* `app-direct` - The App Direct interleaved Persistent Memory type.\n* `app-direct-non-interleaved` - The App Direct non-interleaved Persistent Memory type.", "type": "string", "enum": [ "app-direct", "app-direct-non-interleaved" ], "default": "app-direct", "x-omitempty": true }, "SocketId": { "description": "CPU Socket ID to which this goal will be applied.\n* `All Sockets` - All the CPU socket IDs in a server.", "type": "string", "enum": [ "All Sockets" ], "default": "All Sockets", "x-createOnly": true, "x-omitempty": true } } } ] }, "memory.PersistentMemoryLocalSecurity": { "title": "Persistent Memory Local Security", "description": "Persistent Memory Local Security specification to be applied to the associated servers through this policy.", "x-allOf-name": "memory.PersistentMemoryLocalSecurity", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryLocalSecurity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryLocalSecurity" ], "default": "memory.PersistentMemoryLocalSecurity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryLocalSecurity" ], "default": "memory.PersistentMemoryLocalSecurity", "x-enum-as-string": true }, "Enabled": { "description": "Persistent Memory Security state.", "type": "boolean", "default": false, "x-omitempty": true }, "IsSecurePassphraseSet": { "description": "Indicates whether the value of the 'securePassphrase' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "SecurePassphrase": { "description": "Secure passphrase to be applied on the Persistent Memory Modules on the server. The allowed characters are a-z, A to Z, 0-9, and special characters =, \\u0021, &, \\#, $, %, +, ^, @, _, *, -.", "type": "string", "pattern": "^$|^[a-zA-Z0-9=!&#$%+^@_*-]+$", "minLength": 8, "maxLength": 32, "writeOnly": true, "x-omitempty": true } } } ] }, "memory.PersistentMemoryLogicalNamespace": { "title": "Persistent Memory Logical Namespace", "description": "Persistent Memory Namespace specification that needs to be applied to the associated servers through this policy. This would result in the creation, modification, or deletion of a Namespace on the servers.", "x-allOf-name": "memory.PersistentMemoryLogicalNamespace", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryLogicalNamespace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryLogicalNamespace" ], "default": "memory.PersistentMemoryLogicalNamespace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryLogicalNamespace" ], "default": "memory.PersistentMemoryLogicalNamespace", "x-enum-as-string": true }, "Capacity": { "description": "Capacity of this Namespace that is created or modified.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 9223372036854775807, "x-omitempty": true }, "Mode": { "description": "Mode of this Namespace that is created or modified.\n* `raw` - The raw mode of Persistent Memory Namespace.\n* `block` - The block mode of Persistent Memory Namespace.", "type": "string", "enum": [ "raw", "block" ], "default": "raw", "x-omitempty": true }, "Name": { "description": "Name of this Namespace to be created on the server.", "type": "string", "pattern": "^[a-zA-Z0-9#_-][a-zA-Z0-9#_ -]*$", "minLength": 1, "maxLength": 63, "x-createOnly": true, "x-omitempty": true }, "SocketId": { "description": "Socket ID of the region on which this Namespace has to be created or modified.\n* `1` - The first CPU socket in a server.\n* `2` - The second CPU socket in a server.\n* `3` - The third CPU socket in a server.\n* `4` - The fourth CPU socket in a server.", "type": "integer", "enum": [ 1, 2, 3, 4 ], "default": 1, "x-omitempty": true }, "SocketMemoryId": { "description": "Socket Memory ID of the region on which this Namespace has to be created or modified.\n* `Not Applicable` - The socket memory ID is not applicable if app-direct persistent memory type is selected in the goal.\n* `2` - The second socket memory ID within a socket in a server.\n* `4` - The fourth socket memory ID within a socket in a server.\n* `6` - The sixth socket memory ID within a socket in a server.\n* `8` - The eighth socket memory ID within a socket in a server.\n* `10` - The tenth socket memory ID within a socket in a server.\n* `12` - The twelfth socket memory ID within a socket in a server.", "type": "string", "enum": [ "Not Applicable", "2", "4", "6", "8", "10", "12" ], "default": "Not Applicable", "x-omitempty": true } } } ] }, "memory.PersistentMemoryNamespace.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryNamespace' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryNamespace' resources.", "x-one-of-name": "memory.PersistentMemoryNamespace.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryNamespace.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryNamespace' resource, or the expanded 'memory.PersistentMemoryNamespace' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryNamespace.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryNamespace": { "title": "Memory:Persistent Memory Namespace", "description": "Persistent Memory Namespace configured within a Persistent Memory Region on a server.", "x-allOf-name": "memory.PersistentMemoryNamespace", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryNamespace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryNamespace" ], "default": "memory.PersistentMemoryNamespace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryNamespace" ], "default": "memory.PersistentMemoryNamespace", "x-enum-as-string": true }, "Capacity": { "description": "Capacity in GiB of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "HealthState": { "description": "Health state of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "LabelVersion": { "description": "Label version of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mode": { "description": "Mode of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID of the Persistent Memory Namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryPersistentMemoryRegion": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion.Relationship", "description": "A reference to a memoryPersistentMemoryRegion resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryNamespace.List": { "title": "List of 'memory.PersistentMemoryNamespace' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryNamespace' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryNamespace' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace" }, "nullable": true } } } ] }, "memory.PersistentMemoryNamespaceConfigResult.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryNamespaceConfigResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryNamespaceConfigResult' resources.", "x-one-of-name": "memory.PersistentMemoryNamespaceConfigResult.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryNamespaceConfigResult.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryNamespaceConfigResult' resource, or the expanded 'memory.PersistentMemoryNamespaceConfigResult' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryNamespaceConfigResult.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryNamespaceConfigResult": { "title": "Memory:Persistent Memory Namespace Config Result", "description": "Result of a previously configured Persistent Memory Namespace on a server.", "x-allOf-name": "memory.PersistentMemoryNamespaceConfigResult", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryNamespaceConfigResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryNamespaceConfigResult" ], "default": "memory.PersistentMemoryNamespaceConfigResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryNamespaceConfigResult" ], "default": "memory.PersistentMemoryNamespaceConfigResult", "x-enum-as-string": true }, "ConfigStatus": { "description": "Status of the Persistent Memory Namespace needed to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of a Persistent Memory Namespace that needed to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketId": { "description": "Socket ID in which the Persistent Memory Namespace needed to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketMemoryId": { "description": "Socket Memory ID in which the Persistent Memory Namespace needed to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryPersistentMemoryConfigResult": { "$ref": "#/components/schemas/memory.PersistentMemoryConfigResult.Relationship", "description": "A reference to a memoryPersistentMemoryConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryNamespaceConfigResult.List": { "title": "List of 'memory.PersistentMemoryNamespaceConfigResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryNamespaceConfigResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryNamespaceConfigResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespaceConfigResult" }, "nullable": true } } } ] }, "memory.PersistentMemoryPolicy.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryPolicy' resources.", "x-one-of-name": "memory.PersistentMemoryPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryPolicy": { "title": "Persistent Memory", "description": "The PersistentMemoryPolicy is a reusable policy for configuring Intel Optane Persistent Memory (PMem) modules on supported servers. This provides a comprehensive framework for defining memory operating modes, creating logical namespaces, and managing security.\n#### Purpose\nThe purpose of this policy is to automate and standardize the complex configuration of persistent memory. It allows administrators to define how the PMem modules should be partitioned between volatile memory (Memory Mode) and persistent storage (App Direct Mode). It also handles the creation of namespaces and the application of security passphrases, enabling consistent and repeatable deployments of PMem-enabled servers. \n#### Key Concepts\n- **Memory Goals:** The policy uses \"Goals\" to define the desired ratio of Memory Mode to App Direct Mode for all PMem modules on a given CPU socket.\n- **Logical Namespaces:** Within the App Direct portion, the policy can define one or more logical namespaces, which appear to the operating system as block or raw (DAX) devices.\n- **Local Security:** It supports enabling encryption on the PMem modules by setting a secure passphrase.\n- **Profile-Based and Reboot Required:** The policy is applied via a Server Profile, and its application requires a server reboot to reconfigure the memory subsystem.\n- **Management Mode:** Allows administrators to choose whether the persistent memory is configured by Intersight or managed directly by the operating system.", "x-allOf-name": "memory.PersistentMemoryPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryPolicy" ], "default": "memory.PersistentMemoryPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryPolicy" ], "default": "memory.PersistentMemoryPolicy", "x-enum-as-string": true }, "Goals": { "type": "array", "items": { "description": "The list of Persistent Memory Goals that need to be created through this policy.", "$ref": "#/components/schemas/memory.PersistentMemoryGoal", "x-omitempty": true }, "nullable": true }, "LocalSecurity": { "description": "Local security for the Persistent Memory Modules on the server.", "$ref": "#/components/schemas/memory.PersistentMemoryLocalSecurity", "x-omitempty": true }, "LogicalNamespaces": { "type": "array", "items": { "description": "The list of Persistent Memory Namespace spec that need to be created through this policy.", "$ref": "#/components/schemas/memory.PersistentMemoryLogicalNamespace", "x-omitempty": true }, "nullable": true }, "ManagementMode": { "description": "Management Mode of the policy. This can be either Configured from Intersight or Configured from Operating System.\n* `configured-from-intersight` - The Persistent Memory Modules are configured from Intersight thorugh Persistent Memory policy.\n* `configured-from-operating-system` - The Persistent Memory Modules are configured from operating system thorugh OS tools.", "type": "string", "enum": [ "configured-from-intersight", "configured-from-operating-system" ], "default": "configured-from-intersight", "x-omitempty": true }, "RetainNamespaces": { "description": "Persistent Memory Namespaces to be retained or not.", "type": "boolean", "default": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "memory.PersistentMemoryPolicy.List": { "title": "List of 'memory.PersistentMemoryPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryPolicy" }, "nullable": true } } } ] }, "memory.PersistentMemoryRegion.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryRegion' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryRegion' resources.", "x-one-of-name": "memory.PersistentMemoryRegion.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryRegion.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryRegion.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryRegion' resource, or the expanded 'memory.PersistentMemoryRegion' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryRegion.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryRegion": { "title": "Memory:Persistent Memory Region", "description": "Persistent Memory Region configured on the Persistent Memory Modules on a server.", "x-allOf-name": "memory.PersistentMemoryRegion", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryRegion', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryRegion" ], "default": "memory.PersistentMemoryRegion", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryRegion" ], "default": "memory.PersistentMemoryRegion", "x-enum-as-string": true }, "FreeCapacity": { "description": "Free capacity in GiB of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "HealthState": { "description": "Health state of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterleavedSetId": { "description": "ID of the Interleaved Set formed for this Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocaterIds": { "description": "Set of locator IDs that are included in the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "PersistentMemoryType": { "description": "Persistent Memory type of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegionId": { "description": "ID of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketId": { "description": "Socket ID of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketMemoryId": { "description": "Socket Memory ID of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalCapacity": { "description": "Total capacity in GiB of the Persistent Memory Region.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryPersistentMemoryConfiguration": { "$ref": "#/components/schemas/memory.PersistentMemoryConfiguration.Relationship", "description": "A reference to a memoryPersistentMemoryConfiguration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PersistentMemoryNamespaces": { "description": "An array of relationships to memoryPersistentMemoryNamespace resources.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryNamespace.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryRegion.List": { "title": "List of 'memory.PersistentMemoryRegion' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryRegion' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryRegion' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryRegion" }, "nullable": true } } } ] }, "memory.PersistentMemoryUnit.Response": { "description": "The response body of a HTTP GET request for the 'memory.PersistentMemoryUnit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PersistentMemoryUnit' resources.", "x-one-of-name": "memory.PersistentMemoryUnit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PersistentMemoryUnit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PersistentMemoryUnit.Relationship": { "description": "A relationship to the 'memory.PersistentMemoryUnit' resource, or the expanded 'memory.PersistentMemoryUnit' resource, or the 'null' value.", "x-one-of-name": "memory.PersistentMemoryUnit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.PersistentMemoryUnit": { "title": "Memory:Persistent Memory Unit", "description": "Persistent Memory Module on a server.", "x-allOf-name": "memory.PersistentMemoryUnit", "allOf": [ { "$ref": "#/components/schemas/memory.AbstractUnit" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PersistentMemoryUnit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PersistentMemoryUnit" ], "default": "memory.PersistentMemoryUnit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PersistentMemoryUnit" ], "default": "memory.PersistentMemoryUnit", "x-enum-as-string": true }, "AppDirectCapacity": { "description": "AppDirect capacity in GiB of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "CountStatus": { "description": "Count status of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "Firmware version of the firware running on the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "FrozenStatus": { "description": "Frozen status of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "HealthState": { "description": "Health state of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "LockStatus": { "description": "Lock status of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemoryCapacity": { "description": "Memory capacity in GiB of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemoryId": { "description": "ID of the Persistent Memory Module on a server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PersistentMemoryCapacity": { "description": "Persistent Memory capacity in GiB of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReservedCapacity": { "description": "Reserved capacity in GiB of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SecurityStatus": { "description": "Security status of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketId": { "description": "Socket ID of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SocketMemoryId": { "description": "Socket Memory ID of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalCapacity": { "description": "Total capacity in GiB of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uid": { "description": "UID of the Persistent Memory Module on a server.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryArray": { "$ref": "#/components/schemas/memory.Array.Relationship", "description": "A reference to a memoryArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PersistentMemoryUnit.List": { "title": "List of 'memory.PersistentMemoryUnit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PersistentMemoryUnit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PersistentMemoryUnit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PersistentMemoryUnit" }, "nullable": true } } } ] }, "memory.Policy.Response": { "description": "The response body of a HTTP GET request for the 'memory.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.Policy' resources.", "x-one-of-name": "memory.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.Policy": { "title": "Memory", "description": "The Memory Policy is a reusable policy that allows administrators to manage specific memory-related features on a server.\n#### Purpose\nThe purpose of this policy is to provide a simple, centralized way to control supported memory features. Currently, its primary function is to enable or disable the blocklisting of faulty DIMMs, which can help improve system stability by preventing the use of unreliable memory modules.\n#### Key Concepts\n- **Feature Control:** Provides a toggle for specific memory features. As of now, this is focused on DIMM blocklisting.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to multiple Server Profiles to ensure a consistent memory configuration is applied across different servers.\n- **Simplicity:** It offers a straightforward way to manage memory settings without delving into complex BIOS tokens.", "x-allOf-name": "memory.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.Policy" ], "default": "memory.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.Policy" ], "default": "memory.Policy", "x-enum-as-string": true }, "EnableDimmBlocklisting": { "description": "Enable DIMM Blocklisting on the server.", "type": "boolean", "default": false, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "memory.Policy.List": { "title": "List of 'memory.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Policy" }, "nullable": true } } } ] }, "memory.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'memory.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.PolicyInventory' resources.", "x-one-of-name": "memory.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.PolicyInventory": { "title": "Memory", "description": "The Memory Policy is a reusable policy that allows administrators to manage specific memory-related features on a server.\n#### Purpose\nThe purpose of this policy is to provide a simple, centralized way to control supported memory features. Currently, its primary function is to enable or disable the blocklisting of faulty DIMMs, which can help improve system stability by preventing the use of unreliable memory modules.\n#### Key Concepts\n- **Feature Control:** Provides a toggle for specific memory features. As of now, this is focused on DIMM blocklisting.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to multiple Server Profiles to ensure a consistent memory configuration is applied across different servers.\n- **Simplicity:** It offers a straightforward way to manage memory settings without delving into complex BIOS tokens.", "x-allOf-name": "memory.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.PolicyInventory" ], "default": "memory.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.PolicyInventory" ], "default": "memory.PolicyInventory", "x-enum-as-string": true }, "EnableDimmBlocklisting": { "description": "Enable DIMM Blocklisting on the server.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.PolicyInventory.List": { "title": "List of 'memory.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.PolicyInventory" }, "nullable": true } } } ] }, "memory.Unit.Response": { "description": "The response body of a HTTP GET request for the 'memory.Unit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'memory.Unit' resources.", "x-one-of-name": "memory.Unit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/memory.Unit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "memory.Unit.Relationship": { "description": "A relationship to the 'memory.Unit' resource, or the expanded 'memory.Unit' resource, or the 'null' value.", "x-one-of-name": "memory.Unit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/memory.Unit" } ], "discriminator": { "propertyName": "ClassId" } }, "memory.Unit": { "title": "Memory:Unit", "description": "This represents a memory DIMM on a server.", "x-allOf-name": "memory.Unit", "allOf": [ { "$ref": "#/components/schemas/memory.AbstractUnit" }, { "type": "object", "description": "Definition of the list of properties defined in 'memory.Unit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "memory.Unit" ], "default": "memory.Unit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "memory.Unit" ], "default": "memory.Unit", "x-enum-as-string": true }, "Description": { "description": "This field displays the description of the DIMM.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPlatformSupported": { "description": "This field indicates whether the DIMM is supported on the server or not.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "MemoryId": { "description": "This represents the ID of a regular DIMM on a server.", "deprecated": true, "x-sunset": "2027-03-01", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field displays the part number of the DIMM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field displays the product ID of the DIMM.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MemoryArray": { "$ref": "#/components/schemas/memory.Array.Relationship", "description": "A reference to a memoryArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "memory.Unit.List": { "title": "List of 'memory.Unit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'memory.Unit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'memory.Unit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/memory.Unit" }, "nullable": true } } } ] }, "networkconfig.Policy.Response": { "description": "The response body of a HTTP GET request for the 'networkconfig.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'networkconfig.Policy' resources.", "x-one-of-name": "networkconfig.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/networkconfig.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "networkconfig.Policy": { "title": "Network Connectivity", "description": "The Network Connectivity Policy is a reusable policy that configures DNS settings for a server's management interface (Cisco IMC).\n#### Purpose\nThe purpose of this policy is to standardize the DNS configuration for server management across an organization. It allows administrators to define primary and alternate DNS servers for both IPv4 and IPv6, and to control whether the server should attempt to dynamically register its hostname with a DNS server.\n#### Key Concepts\n- **Centralized DNS Configuration:** Provides a single policy to manage DNS server settings, ensuring consistency across multiple endpoints.\n- **IPv4 and IPv6 Support:** The policy allows for separate DNS configurations for both IP address families.\n- **Dynamic DNS (DDNS):** Includes options to enable dynamic DNS and specify a domain, allowing the server's management controller to automatically update its DNS record.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the settings to the assigned physical server.\n- **Impact Awareness:** Changes to this policy are flagged with MgmtNetworkDisconnection, as updating DNS settings can cause a brief interruption in management connectivity.", "x-allOf-name": "networkconfig.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'networkconfig.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "networkconfig.Policy" ], "default": "networkconfig.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "networkconfig.Policy" ], "default": "networkconfig.Policy", "x-enum-as-string": true }, "AlternateIpv4dnsServer": { "description": "IP address of the secondary DNS server.", "type": "string", "x-omitempty": true }, "AlternateIpv6dnsServer": { "description": "IP address of the secondary DNS server.", "type": "string", "x-omitempty": true }, "DynamicDnsDomain": { "description": "The domain name appended to a hostname for a Dynamic DNS (DDNS) update. If left blank, only a hostname is sent to the DDNS update request.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+([-.]{1}[a-zA-Z0-9]+)*$", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "EnableDynamicDns": { "description": "If enabled, updates the resource records to the DNS from Cisco IMC.", "type": "boolean", "x-omitempty": true }, "EnableIpv4dnsFromDhcp": { "description": "If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv4 in Cisco IMC to enable it.", "type": "boolean", "x-omitempty": true }, "EnableIpv6": { "description": "If enabled, allows to configure IPv6 properties.", "type": "boolean", "x-omitempty": true }, "EnableIpv6dnsFromDhcp": { "description": "If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv6 in Cisco IMC to enable it.", "type": "boolean", "x-omitempty": true }, "PreferredIpv4dnsServer": { "description": "IP address of the primary DNS server.", "type": "string", "x-omitempty": true }, "PreferredIpv6dnsServer": { "description": "IP address of the primary DNS server.", "type": "string", "x-omitempty": true }, "ApplianceAccount": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "networkconfig.Policy.List": { "title": "List of 'networkconfig.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'networkconfig.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'networkconfig.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/networkconfig.Policy" }, "nullable": true } } } ] }, "networkconfig.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'networkconfig.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'networkconfig.PolicyInventory' resources.", "x-one-of-name": "networkconfig.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/networkconfig.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "networkconfig.PolicyInventory": { "title": "Network Connectivity", "description": "The Network Connectivity Policy is a reusable policy that configures DNS settings for a server's management interface (Cisco IMC).\n#### Purpose\nThe purpose of this policy is to standardize the DNS configuration for server management across an organization. It allows administrators to define primary and alternate DNS servers for both IPv4 and IPv6, and to control whether the server should attempt to dynamically register its hostname with a DNS server.\n#### Key Concepts\n- **Centralized DNS Configuration:** Provides a single policy to manage DNS server settings, ensuring consistency across multiple endpoints.\n- **IPv4 and IPv6 Support:** The policy allows for separate DNS configurations for both IP address families.\n- **Dynamic DNS (DDNS):** Includes options to enable dynamic DNS and specify a domain, allowing the server's management controller to automatically update its DNS record.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply the settings to the assigned physical server.\n- **Impact Awareness:** Changes to this policy are flagged with MgmtNetworkDisconnection, as updating DNS settings can cause a brief interruption in management connectivity.", "x-allOf-name": "networkconfig.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'networkconfig.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "networkconfig.PolicyInventory" ], "default": "networkconfig.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "networkconfig.PolicyInventory" ], "default": "networkconfig.PolicyInventory", "x-enum-as-string": true }, "AlternateIpv4dnsServer": { "description": "IP address of the secondary DNS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "AlternateIpv6dnsServer": { "description": "IP address of the secondary DNS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "DynamicDnsDomain": { "description": "The domain name appended to a hostname for a Dynamic DNS (DDNS) update. If left blank, only a hostname is sent to the DDNS update request.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+([-.]{1}[a-zA-Z0-9]+)*$", "minLength": 0, "maxLength": 255, "readOnly": true, "x-omitempty": true }, "EnableDynamicDns": { "description": "If enabled, updates the resource records to the DNS from Cisco IMC.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EnableIpv4dnsFromDhcp": { "description": "If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv4 in Cisco IMC to enable it.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EnableIpv6": { "description": "If enabled, allows to configure IPv6 properties.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "EnableIpv6dnsFromDhcp": { "description": "If enabled, Cisco IMC retrieves the DNS server addresses from DHCP. Use DHCP field must be enabled for IPv6 in Cisco IMC to enable it.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PreferredIpv4dnsServer": { "description": "IP address of the primary DNS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "PreferredIpv6dnsServer": { "description": "IP address of the primary DNS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "networkconfig.PolicyInventory.List": { "title": "List of 'networkconfig.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'networkconfig.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'networkconfig.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/networkconfig.PolicyInventory" }, "nullable": true } } } ] }, "ntp.AuthNtpServer": { "title": "Ntp:Auth Ntp Server", "description": "All the properties of a single authenticated NTP server.", "x-allOf-name": "ntp.AuthNtpServer", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'ntp.AuthNtpServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ntp.AuthNtpServer" ], "default": "ntp.AuthNtpServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ntp.AuthNtpServer" ], "default": "ntp.AuthNtpServer", "x-enum-as-string": true }, "KeyType": { "description": "Type of symmetric key to use for this server.\n* `SHA1` - Key type used by the authentication is SHA1.", "type": "string", "enum": [ "SHA1" ], "default": "SHA1", "x-omitempty": true }, "ServerName": { "description": "Server hostname or IP address.", "type": "string", "x-omitempty": true }, "SymKeyId": { "description": "The key ID is a positive integer that identifies a cryptographic key used to authenticate NTP messages.", "type": "integer", "format": "int64", "x-omitempty": true }, "SymKeyValue": { "description": "The value of the symmetric key.", "type": "string", "x-omitempty": true } } } ] }, "ntp.NtpServer.Response": { "description": "The response body of a HTTP GET request for the 'ntp.NtpServer' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ntp.NtpServer' resources.", "x-one-of-name": "ntp.NtpServer.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ntp.NtpServer.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ntp.NtpServer.Relationship": { "description": "A relationship to the 'ntp.NtpServer' resource, or the expanded 'ntp.NtpServer' resource, or the 'null' value.", "x-one-of-name": "ntp.NtpServer.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/ntp.NtpServer" } ], "discriminator": { "propertyName": "ClassId" } }, "ntp.NtpServer": { "title": "Ntp:Ntp Server", "description": "Concrete class for NTP server configured on a network device. Network Time Protocol (NTP) is used to synchronize with computer clock time sources in a network.", "x-allOf-name": "ntp.NtpServer", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'ntp.NtpServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ntp.NtpServer" ], "default": "ntp.NtpServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ntp.NtpServer" ], "default": "ntp.NtpServer", "x-enum-as-string": true }, "Poll": { "description": "The default polling interval of the NTP server in seconds.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 2048, "readOnly": true, "x-omitempty": true }, "ServerIpAddress": { "description": "The IP address of the NTP server. Supports both IPv4 or IPv6 address.", "type": "string", "readOnly": true, "x-omitempty": true }, "Stratum": { "description": "The stratum level of the NTP server.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 16, "readOnly": true, "x-omitempty": true }, "Type": { "description": "It determines whether the IP address configured is server or peer.\n* `Server` - NTP configured is server type.\n* `Peer` - NTP configured is peer type.", "type": "string", "enum": [ "Server", "Peer" ], "default": "Server", "readOnly": true, "x-omitempty": true }, "VrfName": { "description": "VRF name to be used by NTP Server.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ntp.NtpServer.List": { "title": "List of 'ntp.NtpServer' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ntp.NtpServer' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ntp.NtpServer' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ntp.NtpServer" }, "nullable": true } } } ] }, "ntp.Policy.Response": { "description": "The response body of a HTTP GET request for the 'ntp.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ntp.Policy' resources.", "x-one-of-name": "ntp.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ntp.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ntp.Policy": { "title": "NTP", "description": "The NTP Policy is a reusable policy for configuring Network Time Protocol (NTP) settings on an endpoint.\n#### Purpose\nThe purpose of this policy is to ensure that all managed devices have accurate and synchronized time. By centralizing the configuration of NTP servers and the system timezone, administrators can maintain consistent timekeeping across their infrastructure, which is crucial for accurate logging, event correlation, and security.\n#### Key Concepts\n- **Time Synchronization:** Its primary function is to configure endpoints to synchronize their clocks with designated NTP servers.\n- **Timezone Management:** The policy allows for the setting of a specific timezone for the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile or other profile types to apply the NTP settings to the assigned physical endpoint.", "x-allOf-name": "ntp.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'ntp.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ntp.Policy" ], "default": "ntp.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ntp.Policy" ], "default": "ntp.Policy", "x-enum-as-string": true }, "AuthenticatedNtpServers": { "type": "array", "items": { "description": "Collection of authenticated NTP servers with respective Key Information.", "$ref": "#/components/schemas/ntp.AuthNtpServer", "x-omitempty": true }, "minItems": 0, "maxItems": 4, "nullable": true }, "Enabled": { "description": "State of NTP service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "NtpServers": { "type": "array", "items": { "description": "Collection of unauthenticated NTP server IP addresses or hostnames.", "type": "string", "x-omitempty": true }, "minItems": 0, "maxItems": 4, "nullable": true }, "Timezone": { "description": "Timezone of services on the endpoint.\n* `Pacific/Niue` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Addis_Ababa` - \n* `Africa/Algiers` - \n* `Africa/Asmara` - \n* `Africa/Bamako` - \n* `Africa/Bangui` - \n* `Africa/Banjul` - \n* `Africa/Bissau` - \n* `Africa/Blantyre` - \n* `Africa/Brazzaville` - \n* `Africa/Bujumbura` - \n* `Africa/Cairo` - \n* `Africa/Casablanca` - \n* `Africa/Ceuta` - \n* `Africa/Conakry` - \n* `Africa/Dakar` - \n* `Africa/Dar_es_Salaam` - \n* `Africa/Djibouti` - \n* `Africa/Douala` - \n* `Africa/El_Aaiun` - \n* `Africa/Freetown` - \n* `Africa/Gaborone` - \n* `Africa/Harare` - \n* `Africa/Johannesburg` - \n* `Africa/Juba` - \n* `Africa/Kampala` - \n* `Africa/Khartoum` - \n* `Africa/Kigali` - \n* `Africa/Kinshasa` - \n* `Africa/Lagos` - \n* `Africa/Libreville` - \n* `Africa/Lome` - \n* `Africa/Luanda` - \n* `Africa/Lubumbashi` - \n* `Africa/Lusaka` - \n* `Africa/Malabo` - \n* `Africa/Maputo` - \n* `Africa/Maseru` - \n* `Africa/Mbabane` - \n* `Africa/Mogadishu` - \n* `Africa/Monrovia` - \n* `Africa/Nairobi` - \n* `Africa/Ndjamena` - \n* `Africa/Niamey` - \n* `Africa/Nouakchott` - \n* `Africa/Ouagadougou` - \n* `Africa/Porto-Novo` - \n* `Africa/Sao_Tome` - \n* `Africa/Tripoli` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `America/Adak` - \n* `America/Anchorage` - \n* `America/Anguilla` - \n* `America/Antigua` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Argentina/Catamarca` - \n* `America/Argentina/Cordoba` - \n* `America/Argentina/Jujuy` - \n* `America/Argentina/La_Rioja` - \n* `America/Argentina/Mendoza` - \n* `America/Argentina/Rio_Gallegos` - \n* `America/Argentina/Salta` - \n* `America/Argentina/San_Juan` - \n* `America/Argentina/San_Luis` - \n* `America/Argentina/Tucuman` - \n* `America/Argentina/Ushuaia` - \n* `America/Aruba` - \n* `America/Asuncion` - \n* `America/Atikokan` - \n* `America/Bahia` - \n* `America/Bahia_Banderas` - \n* `America/Barbados` - \n* `America/Belem` - \n* `America/Belize` - \n* `America/Blanc-Sablon` - \n* `America/Boa_Vista` - \n* `America/Bogota` - \n* `America/Boise` - \n* `America/Cambridge_Bay` - \n* `America/Campo_Grande` - \n* `America/Cancun` - \n* `America/Caracas` - \n* `America/Cayenne` - \n* `America/Cayman` - \n* `America/Chicago` - \n* `America/Chihuahua` - \n* `America/Costa_Rica` - \n* `America/Creston` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Danmarkshavn` - \n* `America/Dawson` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Detroit` - \n* `America/Dominica` - \n* `America/Edmonton` - \n* `America/Eirunepe` - \n* `America/El_Salvador` - \n* `America/Fortaleza` - \n* `America/Glace_Bay` - \n* `America/Godthab` - \n* `America/Goose_Bay` - \n* `America/Grand_Turk` - \n* `America/Grenada` - \n* `America/Guadeloupe` - \n* `America/Guatemala` - \n* `America/Guayaquil` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/Havana` - \n* `America/Hermosillo` - \n* `America/Indiana/Indianapolis` - \n* `America/Indiana/Knox` - \n* `America/Indiana/Marengo` - \n* `America/Indiana/Petersburg` - \n* `America/Indiana/Tell_City` - \n* `America/Indiana/Vevay` - \n* `America/Indiana/Vincennes` - \n* `America/Indiana/Winamac` - \n* `America/Inuvik` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Juneau` - \n* `America/Kentucky/Louisville` - \n* `America/Kentucky/Monticello` - \n* `America/Kralendijk` - \n* `America/La_Paz` - \n* `America/Lima` - \n* `America/Los_Angeles` - \n* `America/Lower_Princes` - \n* `America/Maceio` - \n* `America/Managua` - \n* `America/Manaus` - \n* `America/Marigot` - \n* `America/Martinique` - \n* `America/Matamoros` - \n* `America/Mazatlan` - \n* `America/Menominee` - \n* `America/Merida` - \n* `America/Metlakatla` - \n* `America/Mexico_City` - \n* `America/Miquelon` - \n* `America/Moncton` - \n* `America/Monterrey` - \n* `America/Montevideo` - \n* `America/Montreal` - \n* `America/Montserrat` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Nipigon` - \n* `America/Nome` - \n* `America/Noronha` - \n* `America/North_Dakota/Beulah` - \n* `America/North_Dakota/Center` - \n* `America/North_Dakota/New_Salem` - \n* `America/Ojinaga` - \n* `America/Panama` - \n* `America/Pangnirtung` - \n* `America/Paramaribo` - \n* `America/Phoenix` - \n* `America/Port-au-Prince` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Rainy_River` - \n* `America/Rankin_Inlet` - \n* `America/Recife` - \n* `America/Regina` - \n* `America/Resolute` - \n* `America/Rio_Branco` - \n* `America/Santa_Isabel` - \n* `America/Santarem` - \n* `America/Santiago` - \n* `America/Santo_Domingo` - \n* `America/Sao_Paulo` - \n* `America/Scoresbysund` - \n* `America/Shiprock` - \n* `America/Sitka` - \n* `America/St_Barthelemy` - \n* `America/St_Johns` - \n* `America/St_Kitts` - \n* `America/St_Lucia` - \n* `America/St_Thomas` - \n* `America/St_Vincent` - \n* `America/Swift_Current` - \n* `America/Tegucigalpa` - \n* `America/Thule` - \n* `America/Thunder_Bay` - \n* `America/Tijuana` - \n* `America/Toronto` - \n* `America/Tortola` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `America/Winnipeg` - \n* `America/Yakutat` - \n* `America/Yellowknife` - \n* `Antarctica/Casey` - \n* `Antarctica/Davis` - \n* `Antarctica/DumontDUrville` - \n* `Antarctica/Macquarie` - \n* `Antarctica/Mawson` - \n* `Antarctica/McMurdo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Antarctica/South_Pole` - \n* `Antarctica/Syowa` - \n* `Antarctica/Troll` - \n* `Antarctica/Vostok` - \n* `Arctic/Longyearbyen` - \n* `Asia/Aden` - \n* `Asia/Almaty` - \n* `Asia/Amman` - \n* `Asia/Anadyr` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Baghdad` - \n* `Asia/Bahrain` - \n* `Asia/Baku` - \n* `Asia/Bangkok` - \n* `Asia/Beirut` - \n* `Asia/Bishkek` - \n* `Asia/Brunei` - \n* `Asia/Calcutta` - \n* `Asia/Choibalsan` - \n* `Asia/Chongqing` - \n* `Asia/Colombo` - \n* `Asia/Damascus` - \n* `Asia/Dhaka` - \n* `Asia/Dili` - \n* `Asia/Dubai` - \n* `Asia/Dushanbe` - \n* `Asia/Gaza` - \n* `Asia/Harbin` - \n* `Asia/Hebron` - \n* `Asia/Ho_Chi_Minh` - \n* `Asia/Hong_Kong` - \n* `Asia/Hovd` - \n* `Asia/Irkutsk` - \n* `Asia/Jakarta` - \n* `Asia/Jayapura` - \n* `Asia/Jerusalem` - \n* `Asia/Kabul` - \n* `Asia/Kamchatka` - \n* `Asia/Karachi` - \n* `Asia/Kashgar` - \n* `Asia/Kathmandu` - \n* `Asia/Katmandu` - \n* `Asia/Khandyga` - \n* `Asia/Kolkata` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Kuching` - \n* `Asia/Kuwait` - \n* `Asia/Macau` - \n* `Asia/Magadan` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Muscat` - \n* `Asia/Nicosia` - \n* `Asia/Novokuznetsk` - \n* `Asia/Novosibirsk` - \n* `Asia/Omsk` - \n* `Asia/Oral` - \n* `Asia/Phnom_Penh` - \n* `Asia/Pontianak` - \n* `Asia/Pyongyang` - \n* `Asia/Qatar` - \n* `Asia/Qyzylorda` - \n* `Asia/Rangoon` - \n* `Asia/Riyadh` - \n* `Asia/Saigon` - \n* `Asia/Sakhalin` - \n* `Asia/Samarkand` - \n* `Asia/Seoul` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Tashkent` - \n* `Asia/Tbilisi` - \n* `Asia/Tehran` - \n* `Asia/Thimphu` - \n* `Asia/Tokyo` - \n* `Asia/Ulaanbaatar` - \n* `Asia/Urumqi` - \n* `Asia/Ust-Nera` - \n* `Asia/Vientiane` - \n* `Asia/Vladivostok` - \n* `Asia/Yakutsk` - \n* `Asia/Yekaterinburg` - \n* `Asia/Yerevan` - \n* `Atlantic/Azores` - \n* `Atlantic/Bermuda` - \n* `Atlantic/Canary` - \n* `Atlantic/Cape_Verde` - \n* `Atlantic/Faroe` - \n* `Atlantic/Madeira` - \n* `Atlantic/Reykjavik` - \n* `Atlantic/South_Georgia` - \n* `Atlantic/St_Helena` - \n* `Atlantic/Stanley` - \n* `Australia/Adelaide` - \n* `Australia/Brisbane` - \n* `Australia/Broken_Hill` - \n* `Australia/Currie` - \n* `Australia/Darwin` - \n* `Australia/Eucla` - \n* `Australia/Hobart` - \n* `Australia/Lindeman` - \n* `Australia/Lord_Howe` - \n* `Australia/Melbourne` - \n* `Australia/Perth` - \n* `Australia/Sydney` - \n* `Etc/GMT` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Athens` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Bratislava` - \n* `Europe/Brussels` - \n* `Europe/Bucharest` - \n* `Europe/Budapest` - \n* `Europe/Busingen` - \n* `Europe/Chisinau` - \n* `Europe/Copenhagen` - \n* `Europe/Dublin` - \n* `Europe/Gibraltar` - \n* `Europe/Guernsey` - \n* `Europe/Helsinki` - \n* `Europe/Isle_of_Man` - \n* `Europe/Istanbul` - \n* `Europe/Jersey` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Lisbon` - \n* `Europe/Ljubljana` - \n* `Europe/London` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Mariehamn` - \n* `Europe/Minsk` - \n* `Europe/Monaco` - \n* `Europe/Moscow` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Podgorica` - \n* `Europe/Prague` - \n* `Europe/Riga` - \n* `Europe/Rome` - \n* `Europe/Samara` - \n* `Europe/San_Marino` - \n* `Europe/Sarajevo` - \n* `Europe/Simferopol` - \n* `Europe/Skopje` - \n* `Europe/Sofia` - \n* `Europe/Stockholm` - \n* `Europe/Tallinn` - \n* `Europe/Tirane` - \n* `Europe/Uzhgorod` - \n* `Europe/Vaduz` - \n* `Europe/Vatican` - \n* `Europe/Vienna` - \n* `Europe/Vilnius` - \n* `Europe/Volgograd` - \n* `Europe/Warsaw` - \n* `Europe/Zagreb` - \n* `Europe/Zaporozhye` - \n* `Europe/Zurich` - \n* `Indian/Antananarivo` - \n* `Indian/Chagos` - \n* `Indian/Christmas` - \n* `Indian/Cocos` - \n* `Indian/Comoro` - \n* `Indian/Kerguelen` - \n* `Indian/Mahe` - \n* `Indian/Maldives` - \n* `Indian/Mauritius` - \n* `Indian/Mayotte` - \n* `Indian/Reunion` - \n* `Pacific/Apia` - \n* `Pacific/Auckland` - \n* `Pacific/Chatham` - \n* `Pacific/Chuuk` - \n* `Pacific/Easter` - \n* `Pacific/Efate` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Galapagos` - \n* `Pacific/Gambier` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Guam` - \n* `Pacific/Honolulu` - \n* `Pacific/Johnston` - \n* `Pacific/Kiritimati` - \n* `Pacific/Kosrae` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Marquesas` - \n* `Pacific/Midway` - \n* `Pacific/Nauru` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pago_Pago` - \n* `Pacific/Palau` - \n* `Pacific/Pitcairn` - \n* `Pacific/Pohnpei` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Rarotonga` - \n* `Pacific/Saipan` - \n* `Pacific/Tahiti` - \n* `Pacific/Tarawa` - \n* `Pacific/Tongatapu` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `UTC` -", "type": "string", "enum": [ "Pacific/Niue", "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Etc/GMT", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC" ], "default": "Pacific/Niue", "x-omitempty": true }, "ApplianceAccount": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "ntp.Policy.List": { "title": "List of 'ntp.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ntp.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ntp.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ntp.Policy" }, "nullable": true } } } ] }, "ntp.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'ntp.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ntp.PolicyInventory' resources.", "x-one-of-name": "ntp.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ntp.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ntp.PolicyInventory": { "title": "NTP", "description": "The NTP Policy is a reusable policy for configuring Network Time Protocol (NTP) settings on an endpoint.\n#### Purpose\nThe purpose of this policy is to ensure that all managed devices have accurate and synchronized time. By centralizing the configuration of NTP servers and the system timezone, administrators can maintain consistent timekeeping across their infrastructure, which is crucial for accurate logging, event correlation, and security.\n#### Key Concepts\n- **Time Synchronization:** Its primary function is to configure endpoints to synchronize their clocks with designated NTP servers.\n- **Timezone Management:** The policy allows for the setting of a specific timezone for the endpoint.\n- **Profile-Based Application:** The policy is attached to a Server Profile or other profile types to apply the NTP settings to the assigned physical endpoint.", "x-allOf-name": "ntp.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'ntp.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ntp.PolicyInventory" ], "default": "ntp.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ntp.PolicyInventory" ], "default": "ntp.PolicyInventory", "x-enum-as-string": true }, "AuthenticatedNtpServers": { "type": "array", "items": { "description": "Collection of authenticated NTP servers with respective Key Information.", "$ref": "#/components/schemas/ntp.AuthNtpServer", "readOnly": true, "x-omitempty": true }, "minItems": 0, "maxItems": 4, "nullable": true }, "Enabled": { "description": "State of NTP service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "NtpServers": { "type": "array", "items": { "description": "Collection of unauthenticated NTP server IP addresses or hostnames.", "type": "string", "readOnly": true, "x-omitempty": true }, "minItems": 0, "maxItems": 4, "nullable": true }, "Timezone": { "description": "Timezone of services on the endpoint.\n* `Pacific/Niue` - \n* `Africa/Abidjan` - \n* `Africa/Accra` - \n* `Africa/Addis_Ababa` - \n* `Africa/Algiers` - \n* `Africa/Asmara` - \n* `Africa/Bamako` - \n* `Africa/Bangui` - \n* `Africa/Banjul` - \n* `Africa/Bissau` - \n* `Africa/Blantyre` - \n* `Africa/Brazzaville` - \n* `Africa/Bujumbura` - \n* `Africa/Cairo` - \n* `Africa/Casablanca` - \n* `Africa/Ceuta` - \n* `Africa/Conakry` - \n* `Africa/Dakar` - \n* `Africa/Dar_es_Salaam` - \n* `Africa/Djibouti` - \n* `Africa/Douala` - \n* `Africa/El_Aaiun` - \n* `Africa/Freetown` - \n* `Africa/Gaborone` - \n* `Africa/Harare` - \n* `Africa/Johannesburg` - \n* `Africa/Juba` - \n* `Africa/Kampala` - \n* `Africa/Khartoum` - \n* `Africa/Kigali` - \n* `Africa/Kinshasa` - \n* `Africa/Lagos` - \n* `Africa/Libreville` - \n* `Africa/Lome` - \n* `Africa/Luanda` - \n* `Africa/Lubumbashi` - \n* `Africa/Lusaka` - \n* `Africa/Malabo` - \n* `Africa/Maputo` - \n* `Africa/Maseru` - \n* `Africa/Mbabane` - \n* `Africa/Mogadishu` - \n* `Africa/Monrovia` - \n* `Africa/Nairobi` - \n* `Africa/Ndjamena` - \n* `Africa/Niamey` - \n* `Africa/Nouakchott` - \n* `Africa/Ouagadougou` - \n* `Africa/Porto-Novo` - \n* `Africa/Sao_Tome` - \n* `Africa/Tripoli` - \n* `Africa/Tunis` - \n* `Africa/Windhoek` - \n* `America/Adak` - \n* `America/Anchorage` - \n* `America/Anguilla` - \n* `America/Antigua` - \n* `America/Araguaina` - \n* `America/Argentina/Buenos_Aires` - \n* `America/Argentina/Catamarca` - \n* `America/Argentina/Cordoba` - \n* `America/Argentina/Jujuy` - \n* `America/Argentina/La_Rioja` - \n* `America/Argentina/Mendoza` - \n* `America/Argentina/Rio_Gallegos` - \n* `America/Argentina/Salta` - \n* `America/Argentina/San_Juan` - \n* `America/Argentina/San_Luis` - \n* `America/Argentina/Tucuman` - \n* `America/Argentina/Ushuaia` - \n* `America/Aruba` - \n* `America/Asuncion` - \n* `America/Atikokan` - \n* `America/Bahia` - \n* `America/Bahia_Banderas` - \n* `America/Barbados` - \n* `America/Belem` - \n* `America/Belize` - \n* `America/Blanc-Sablon` - \n* `America/Boa_Vista` - \n* `America/Bogota` - \n* `America/Boise` - \n* `America/Cambridge_Bay` - \n* `America/Campo_Grande` - \n* `America/Cancun` - \n* `America/Caracas` - \n* `America/Cayenne` - \n* `America/Cayman` - \n* `America/Chicago` - \n* `America/Chihuahua` - \n* `America/Costa_Rica` - \n* `America/Creston` - \n* `America/Cuiaba` - \n* `America/Curacao` - \n* `America/Danmarkshavn` - \n* `America/Dawson` - \n* `America/Dawson_Creek` - \n* `America/Denver` - \n* `America/Detroit` - \n* `America/Dominica` - \n* `America/Edmonton` - \n* `America/Eirunepe` - \n* `America/El_Salvador` - \n* `America/Fortaleza` - \n* `America/Glace_Bay` - \n* `America/Godthab` - \n* `America/Goose_Bay` - \n* `America/Grand_Turk` - \n* `America/Grenada` - \n* `America/Guadeloupe` - \n* `America/Guatemala` - \n* `America/Guayaquil` - \n* `America/Guyana` - \n* `America/Halifax` - \n* `America/Havana` - \n* `America/Hermosillo` - \n* `America/Indiana/Indianapolis` - \n* `America/Indiana/Knox` - \n* `America/Indiana/Marengo` - \n* `America/Indiana/Petersburg` - \n* `America/Indiana/Tell_City` - \n* `America/Indiana/Vevay` - \n* `America/Indiana/Vincennes` - \n* `America/Indiana/Winamac` - \n* `America/Inuvik` - \n* `America/Iqaluit` - \n* `America/Jamaica` - \n* `America/Juneau` - \n* `America/Kentucky/Louisville` - \n* `America/Kentucky/Monticello` - \n* `America/Kralendijk` - \n* `America/La_Paz` - \n* `America/Lima` - \n* `America/Los_Angeles` - \n* `America/Lower_Princes` - \n* `America/Maceio` - \n* `America/Managua` - \n* `America/Manaus` - \n* `America/Marigot` - \n* `America/Martinique` - \n* `America/Matamoros` - \n* `America/Mazatlan` - \n* `America/Menominee` - \n* `America/Merida` - \n* `America/Metlakatla` - \n* `America/Mexico_City` - \n* `America/Miquelon` - \n* `America/Moncton` - \n* `America/Monterrey` - \n* `America/Montevideo` - \n* `America/Montreal` - \n* `America/Montserrat` - \n* `America/Nassau` - \n* `America/New_York` - \n* `America/Nipigon` - \n* `America/Nome` - \n* `America/Noronha` - \n* `America/North_Dakota/Beulah` - \n* `America/North_Dakota/Center` - \n* `America/North_Dakota/New_Salem` - \n* `America/Ojinaga` - \n* `America/Panama` - \n* `America/Pangnirtung` - \n* `America/Paramaribo` - \n* `America/Phoenix` - \n* `America/Port-au-Prince` - \n* `America/Port_of_Spain` - \n* `America/Porto_Velho` - \n* `America/Puerto_Rico` - \n* `America/Rainy_River` - \n* `America/Rankin_Inlet` - \n* `America/Recife` - \n* `America/Regina` - \n* `America/Resolute` - \n* `America/Rio_Branco` - \n* `America/Santa_Isabel` - \n* `America/Santarem` - \n* `America/Santiago` - \n* `America/Santo_Domingo` - \n* `America/Sao_Paulo` - \n* `America/Scoresbysund` - \n* `America/Shiprock` - \n* `America/Sitka` - \n* `America/St_Barthelemy` - \n* `America/St_Johns` - \n* `America/St_Kitts` - \n* `America/St_Lucia` - \n* `America/St_Thomas` - \n* `America/St_Vincent` - \n* `America/Swift_Current` - \n* `America/Tegucigalpa` - \n* `America/Thule` - \n* `America/Thunder_Bay` - \n* `America/Tijuana` - \n* `America/Toronto` - \n* `America/Tortola` - \n* `America/Vancouver` - \n* `America/Whitehorse` - \n* `America/Winnipeg` - \n* `America/Yakutat` - \n* `America/Yellowknife` - \n* `Antarctica/Casey` - \n* `Antarctica/Davis` - \n* `Antarctica/DumontDUrville` - \n* `Antarctica/Macquarie` - \n* `Antarctica/Mawson` - \n* `Antarctica/McMurdo` - \n* `Antarctica/Palmer` - \n* `Antarctica/Rothera` - \n* `Antarctica/South_Pole` - \n* `Antarctica/Syowa` - \n* `Antarctica/Troll` - \n* `Antarctica/Vostok` - \n* `Arctic/Longyearbyen` - \n* `Asia/Aden` - \n* `Asia/Almaty` - \n* `Asia/Amman` - \n* `Asia/Anadyr` - \n* `Asia/Aqtau` - \n* `Asia/Aqtobe` - \n* `Asia/Ashgabat` - \n* `Asia/Baghdad` - \n* `Asia/Bahrain` - \n* `Asia/Baku` - \n* `Asia/Bangkok` - \n* `Asia/Beirut` - \n* `Asia/Bishkek` - \n* `Asia/Brunei` - \n* `Asia/Calcutta` - \n* `Asia/Choibalsan` - \n* `Asia/Chongqing` - \n* `Asia/Colombo` - \n* `Asia/Damascus` - \n* `Asia/Dhaka` - \n* `Asia/Dili` - \n* `Asia/Dubai` - \n* `Asia/Dushanbe` - \n* `Asia/Gaza` - \n* `Asia/Harbin` - \n* `Asia/Hebron` - \n* `Asia/Ho_Chi_Minh` - \n* `Asia/Hong_Kong` - \n* `Asia/Hovd` - \n* `Asia/Irkutsk` - \n* `Asia/Jakarta` - \n* `Asia/Jayapura` - \n* `Asia/Jerusalem` - \n* `Asia/Kabul` - \n* `Asia/Kamchatka` - \n* `Asia/Karachi` - \n* `Asia/Kashgar` - \n* `Asia/Kathmandu` - \n* `Asia/Katmandu` - \n* `Asia/Khandyga` - \n* `Asia/Kolkata` - \n* `Asia/Krasnoyarsk` - \n* `Asia/Kuala_Lumpur` - \n* `Asia/Kuching` - \n* `Asia/Kuwait` - \n* `Asia/Macau` - \n* `Asia/Magadan` - \n* `Asia/Makassar` - \n* `Asia/Manila` - \n* `Asia/Muscat` - \n* `Asia/Nicosia` - \n* `Asia/Novokuznetsk` - \n* `Asia/Novosibirsk` - \n* `Asia/Omsk` - \n* `Asia/Oral` - \n* `Asia/Phnom_Penh` - \n* `Asia/Pontianak` - \n* `Asia/Pyongyang` - \n* `Asia/Qatar` - \n* `Asia/Qyzylorda` - \n* `Asia/Rangoon` - \n* `Asia/Riyadh` - \n* `Asia/Saigon` - \n* `Asia/Sakhalin` - \n* `Asia/Samarkand` - \n* `Asia/Seoul` - \n* `Asia/Shanghai` - \n* `Asia/Singapore` - \n* `Asia/Taipei` - \n* `Asia/Tashkent` - \n* `Asia/Tbilisi` - \n* `Asia/Tehran` - \n* `Asia/Thimphu` - \n* `Asia/Tokyo` - \n* `Asia/Ulaanbaatar` - \n* `Asia/Urumqi` - \n* `Asia/Ust-Nera` - \n* `Asia/Vientiane` - \n* `Asia/Vladivostok` - \n* `Asia/Yakutsk` - \n* `Asia/Yekaterinburg` - \n* `Asia/Yerevan` - \n* `Atlantic/Azores` - \n* `Atlantic/Bermuda` - \n* `Atlantic/Canary` - \n* `Atlantic/Cape_Verde` - \n* `Atlantic/Faroe` - \n* `Atlantic/Madeira` - \n* `Atlantic/Reykjavik` - \n* `Atlantic/South_Georgia` - \n* `Atlantic/St_Helena` - \n* `Atlantic/Stanley` - \n* `Australia/Adelaide` - \n* `Australia/Brisbane` - \n* `Australia/Broken_Hill` - \n* `Australia/Currie` - \n* `Australia/Darwin` - \n* `Australia/Eucla` - \n* `Australia/Hobart` - \n* `Australia/Lindeman` - \n* `Australia/Lord_Howe` - \n* `Australia/Melbourne` - \n* `Australia/Perth` - \n* `Australia/Sydney` - \n* `Etc/GMT` - \n* `Europe/Amsterdam` - \n* `Europe/Andorra` - \n* `Europe/Athens` - \n* `Europe/Belgrade` - \n* `Europe/Berlin` - \n* `Europe/Bratislava` - \n* `Europe/Brussels` - \n* `Europe/Bucharest` - \n* `Europe/Budapest` - \n* `Europe/Busingen` - \n* `Europe/Chisinau` - \n* `Europe/Copenhagen` - \n* `Europe/Dublin` - \n* `Europe/Gibraltar` - \n* `Europe/Guernsey` - \n* `Europe/Helsinki` - \n* `Europe/Isle_of_Man` - \n* `Europe/Istanbul` - \n* `Europe/Jersey` - \n* `Europe/Kaliningrad` - \n* `Europe/Kiev` - \n* `Europe/Lisbon` - \n* `Europe/Ljubljana` - \n* `Europe/London` - \n* `Europe/Luxembourg` - \n* `Europe/Madrid` - \n* `Europe/Malta` - \n* `Europe/Mariehamn` - \n* `Europe/Minsk` - \n* `Europe/Monaco` - \n* `Europe/Moscow` - \n* `Europe/Oslo` - \n* `Europe/Paris` - \n* `Europe/Podgorica` - \n* `Europe/Prague` - \n* `Europe/Riga` - \n* `Europe/Rome` - \n* `Europe/Samara` - \n* `Europe/San_Marino` - \n* `Europe/Sarajevo` - \n* `Europe/Simferopol` - \n* `Europe/Skopje` - \n* `Europe/Sofia` - \n* `Europe/Stockholm` - \n* `Europe/Tallinn` - \n* `Europe/Tirane` - \n* `Europe/Uzhgorod` - \n* `Europe/Vaduz` - \n* `Europe/Vatican` - \n* `Europe/Vienna` - \n* `Europe/Vilnius` - \n* `Europe/Volgograd` - \n* `Europe/Warsaw` - \n* `Europe/Zagreb` - \n* `Europe/Zaporozhye` - \n* `Europe/Zurich` - \n* `Indian/Antananarivo` - \n* `Indian/Chagos` - \n* `Indian/Christmas` - \n* `Indian/Cocos` - \n* `Indian/Comoro` - \n* `Indian/Kerguelen` - \n* `Indian/Mahe` - \n* `Indian/Maldives` - \n* `Indian/Mauritius` - \n* `Indian/Mayotte` - \n* `Indian/Reunion` - \n* `Pacific/Apia` - \n* `Pacific/Auckland` - \n* `Pacific/Chatham` - \n* `Pacific/Chuuk` - \n* `Pacific/Easter` - \n* `Pacific/Efate` - \n* `Pacific/Enderbury` - \n* `Pacific/Fakaofo` - \n* `Pacific/Fiji` - \n* `Pacific/Funafuti` - \n* `Pacific/Galapagos` - \n* `Pacific/Gambier` - \n* `Pacific/Guadalcanal` - \n* `Pacific/Guam` - \n* `Pacific/Honolulu` - \n* `Pacific/Johnston` - \n* `Pacific/Kiritimati` - \n* `Pacific/Kosrae` - \n* `Pacific/Kwajalein` - \n* `Pacific/Majuro` - \n* `Pacific/Marquesas` - \n* `Pacific/Midway` - \n* `Pacific/Nauru` - \n* `Pacific/Norfolk` - \n* `Pacific/Noumea` - \n* `Pacific/Pago_Pago` - \n* `Pacific/Palau` - \n* `Pacific/Pitcairn` - \n* `Pacific/Pohnpei` - \n* `Pacific/Port_Moresby` - \n* `Pacific/Rarotonga` - \n* `Pacific/Saipan` - \n* `Pacific/Tahiti` - \n* `Pacific/Tarawa` - \n* `Pacific/Tongatapu` - \n* `Pacific/Wake` - \n* `Pacific/Wallis` - \n* `UTC` -", "type": "string", "enum": [ "Pacific/Niue", "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Etc/GMT", "Europe/Amsterdam", "Europe/Andorra", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Wake", "Pacific/Wallis", "UTC" ], "default": "Pacific/Niue", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ntp.PolicyInventory.List": { "title": "List of 'ntp.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ntp.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ntp.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ntp.PolicyInventory" }, "nullable": true } } } ] }, "os.Answers": { "title": "Os:Answers", "description": "This MO captures the values for the most common set of fields in OS specific\nanswer files. The values provided in this MO are used to construct the OS specific\nanswer files (kickstart, seed, unattended xml) by replacing the fields/placeholders\nin selected os.ConfigurationFile content with the values of this MO properties.", "x-allOf-name": "os.Answers", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Answers', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Answers" ], "default": "os.Answers", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Answers" ], "default": "os.Answers", "x-enum-as-string": true }, "AlternateNameServers": { "type": "array", "items": { "description": "Alternate Name Servers can be configured in the OS.", "type": "string", "x-omitempty": true }, "nullable": true }, "AnswerFile": { "description": "If the source of the answers is a static file, the content of the file is stored as value\nin this property.\nThe value is mandatory only when the 'Source' property has been set to 'File'.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Hostname": { "description": "Hostname to be configured for the server in the OS.", "type": "string", "x-omitempty": true }, "IpConfigType": { "description": "IP configuration type. Values are Static or Dynamic configuration of IP.\nIn case of static IP configuration, IP address, gateway and other details need\nto be populated. In case of dynamic the IP configuration is obtained dynamically\nfrom DHCP.\n* `static` - In case of static IP configuraton, provide the details such as IP address, netmask, and gateway.\n* `DHCP` - In case of dynamic IP configuration, the IP address, netmask and gateway detailsare obtained from DHCP.", "type": "string", "enum": [ "static", "DHCP" ], "default": "static", "x-omitempty": true }, "IpConfiguration": { "description": "In case of static IP configuration, IP address, netmask and gateway details are\nprovided.", "$ref": "#/components/schemas/os.IpConfiguration", "x-omitempty": true }, "IsAnswerFileSet": { "description": "Indicates whether the value of the 'answerFile' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsRootPasswordCrypted": { "description": "Enable to indicate Root Password provided is encrypted.", "type": "boolean", "x-omitempty": true }, "IsRootPasswordSet": { "description": "Indicates whether the value of the 'rootPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Nameserver": { "description": "IP address of the name server to be configured in the OS.", "type": "string", "x-omitempty": true }, "NetworkDevice": { "description": "Network Device where the IP address must be configured. Network Interface names and MAC address are supported.\nFor SUSE Linux Enterprise Server, Network Interface name is a required input and if provided as a MAC address,\nA persistent interface name is binded to the MAC address and the interface name will be used for network configuration.\nRefer https://documentation.suse.com/sles/15-SP2/html/SLES-all/cha-configuration-installation-options.html#CreateProfile-Network-names.", "type": "string", "x-omitempty": true }, "ProductKey": { "description": "The product key to be used for a specific version of Windows installation.", "type": "string", "x-omitempty": true }, "RootPassword": { "description": "Password configured for the root / administrator user in the OS. You can enter a plain text or an encrypted password.\nIntersight encrypts the plaintext password. Enable the Encrypted Password option to provide an encrypted password.\nFor more details on encrypting passwords, see Help Center.", "type": "string", "writeOnly": true, "x-omitempty": true }, "Source": { "description": "Answer values can be provided from three sources - Embedded in OS image, static file,\nor as placeholder values for an answer file template.\nSource of the answers is given as value, Embedded/File/Template.\n'Embedded' option indicates that the answer file is embedded within the OS Image. 'File'\noption indicates that the answers are provided as a file. 'Template' indicates that the\nplaceholders in the selected os.ConfigurationFile MO are replaced with values provided\nas os.Answers MO.\n* `None` - Indicates that answers is not sent and values must be populated from Install Template. \n* `Embedded` - Indicates that the answer file is embedded within OS image.\n* `File` - Indicates that the answer file is a static content that has all thevalues populated.\n* `Template` - Indicates that the given answers are used to populate the answer filetemplate. The template allows the users to refer some server specificanswers as fields/placeholders and replace these placeholders with theactual values for each Server during OS installation using 'Answers' and'AdditionalParameters' properties in os.Install MO.The answer file templates can be created by users as os.ConfigurationFile objects.", "type": "string", "enum": [ "None", "Embedded", "File", "Template" ], "default": "None", "x-omitempty": true } } } ] }, "os.BaseInstallConfig": { "title": "Base OS Install Configuration", "description": "BaseInstallConfig models the configuration required to install OS.", "x-allOf-name": "os.BaseInstallConfig", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.BaseInstallConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.Install" ], "default": "os.Install", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.Install" ], "default": "os.Install", "x-enum-as-string": true }, "AdditionalParameters": { "type": "array", "items": { "description": "If the os.ConfigurationFile MO selected is a template that uses additional\nplaceholders other than the ones provided in standard os.Answers MO, the values\nfor those additional placeholders are provided here.", "$ref": "#/components/schemas/os.PlaceHolder", "x-omitempty": true }, "nullable": true }, "Answers": { "description": "Answers provided by user for the unattended OS installation.", "$ref": "#/components/schemas/os.Answers", "x-omitempty": true }, "Description": { "description": "User provided description about the OS install configuration.", "type": "string", "x-omitempty": true }, "ErrorMsg": { "description": "The failure message of the API.", "type": "string", "readOnly": true, "x-omitempty": true }, "InstallMethod": { "description": "The install method to be used for OS installation - vMedia, iPXE. \nOnly vMedia is supported as of now.\n* `vMedia` - OS image is mounted as vMedia in target server for OS installation.", "type": "string", "enum": [ "vMedia" ], "default": "vMedia", "x-omitempty": true }, "InstallTarget": { "description": "Install Target on which Operating system is installed.", "$ref": "#/components/schemas/os.InstallTarget", "x-omitempty": true }, "OperState": { "description": "Denotes API operating status as pending, in_progress, completed_ok, completed_error based on the execution status.\n* `Pending` - The initial value of the OperStatus.\n* `InProgress` - The OperStatus value will be InProgress during execution.\n* `CompletedOk` - The API is successful with operation then OperStatus will be marked as CompletedOk.\n* `CompletedError` - The API is failed with operation then OperStatus will be marked as CompletedError.\n* `CompletedWarning` - The API is completed with some warning then OperStatus will be CompletedWarning.", "type": "string", "enum": [ "Pending", "InProgress", "CompletedOk", "CompletedError", "CompletedWarning" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "OperatingSystemParameters": { "description": "Parameters specific to selected OS.", "$ref": "#/components/schemas/os.OperatingSystemParameters", "x-omitempty": true }, "OverrideSecureBoot": { "description": "ESXi Secure Boot installation is currently not supported. As a workaround, Secure Boot will be disabled before installation and restored after installation is complete. Enable to Override Secure Boot Configuration.", "type": "boolean", "x-omitempty": true } } } ] }, "os.BulkInstallInfo.Response": { "description": "The response body of a HTTP GET request for the 'os.BulkInstallInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.BulkInstallInfo' resources.", "x-one-of-name": "os.BulkInstallInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.BulkInstallInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.BulkInstallInfo": { "title": "Bulk OS Install From CSV", "description": "The BulkInstallInfo object is a critical element in the automation of operating system installations across multiple servers. It models the content of CSV files that hold configuration parameters for bulk OS installations, ensuring streamlined and efficient deployment.\n#### Purpose\nBulkInstallInfo facilitates the mass deployment of operating systems by encapsulating necessary parameters within a CSV file. This supports validation processes and manages installation configurations, enabling administrators to efficiently deploy OS across multiple servers.\n#### Key Concepts\n- **CSV-Based Deployment:** Utilizes CSV files to store OS installation parameters, providing a scalable solution for deploying operating systems to numerous servers.\n- **Validation Process:** Includes built-in validation mechanisms to ensure the accuracy and completeness of installation configurations.\n- **Access Control:** Enforces privilege sets such as Account Administrator and Manage Servers, ensuring that only authorized personnel can create and manage bulk installations.\n- **Server-Specific Configurations:** Manages configurations specific to each server, allowing customized installations tailored to individual server requirements.", "x-allOf-name": "os.BulkInstallInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.BulkInstallInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.BulkInstallInfo" ], "default": "os.BulkInstallInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.BulkInstallInfo" ], "default": "os.BulkInstallInfo", "x-enum-as-string": true }, "FileContent": { "description": "The content of the entire CSV file is stored as value. The content can hold complete OS install parameters in two sections.\nThe first section holds generic information about the OS Install like OS Image, SCU Image etc. The second section holds\nparameters which are specific to each server level data.", "type": "string", "writeOnly": true, "x-omitempty": true }, "GlobalConfig": { "description": "The global parameter of the CSV file.", "$ref": "#/components/schemas/os.GlobalConfig", "readOnly": true, "x-omitempty": true }, "IsFileContentSet": { "description": "Indicates whether the value of the 'fileContent' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the CSV file, which holds the OS install parameters.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "OperState": { "description": "Denotes if the operating is pending, in_progress, completed_ok, completed_error.\n* `Pending` - The initial value of the OperStatus.\n* `InProgress` - The OperStatus value will be InProgress during execution.\n* `CompletedOk` - The API is successful with operation then OperStatus will be marked as CompletedOk.\n* `CompletedError` - The API is failed with operation then OperStatus will be marked as CompletedError.\n* `CompletedWarning` - The API is completed with some warning then OperStatus will be CompletedWarning.", "type": "string", "enum": [ "Pending", "InProgress", "CompletedOk", "CompletedError", "CompletedWarning" ], "default": "Pending", "readOnly": true, "x-omitempty": true }, "ServerConfigs": { "type": "array", "items": { "description": "The server specific configurations of the CSV file.", "$ref": "#/components/schemas/os.ServerConfig", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ValidationInfos": { "type": "array", "items": { "description": "The complete valiation check and its status.", "$ref": "#/components/schemas/os.ValidationInformation", "x-createOnly": true, "x-omitempty": true }, "nullable": true }, "ConfigurationFile": { "$ref": "#/components/schemas/os.ConfigurationFile.Relationship", "description": "A reference to a osConfigurationFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "OsImage": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.OperatingSystemFile.Relationship", "description": "A reference to a softwarerepositoryOperatingSystemFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "ScuImage": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable.Relationship", "description": "A reference to a firmwareServerConfigurationUtilityDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Servers": { "description": "An array of relationships to computePhysical resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Physical.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "os.BulkInstallInfo.List": { "title": "List of 'os.BulkInstallInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.BulkInstallInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.BulkInstallInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.BulkInstallInfo" }, "nullable": true } } } ] }, "os.Catalog.Response": { "description": "The response body of a HTTP GET request for the 'os.Catalog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.Catalog' resources.", "x-one-of-name": "os.Catalog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.Catalog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.Catalog.Relationship": { "description": "A relationship to the 'os.Catalog' resource, or the expanded 'os.Catalog' resource, or the 'null' value.", "x-one-of-name": "os.Catalog.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/os.Catalog" } ], "discriminator": { "propertyName": "ClassId" } }, "os.Catalog": { "title": "Os:Catalog", "description": "The Catalog object is an integral component of the operating system management framework, specifically designed to handle collections of operating system-related artifacts such as configuration files and post-installation scripts. It is pivotal in organizing and managing these artifacts within user accounts and system contexts.\n#### Purpose\nA Catalog serves as a repository for operating system configuration files and scripts, facilitating both private storage by users and shared access managed by Cisco. It enables efficient OS installations by providing validated files and scripts, which users can leverage in their Intersight account environments.\n#### Key Concepts\n - **Object Organization:** Catalogs offer structured storage for configuration files and scripts, ensuring easy access and management within user accounts.\n - **Cisco-Managed Shared Catalogs:** Cisco manages shared catalogs, allowing users to read and utilize validated files and scripts for OS installations. Contributions to shared catalogs are published by Cisco at its discretion.\n - **Access Control:** Different privilege sets are enforced to ensure secure and authorized access, with Account Administrators and View Servers privileges being essential for reading catalog contents.\n - **Relationship Management:** Catalog objects maintain relationships with other components, such as configuration files and OS distributions, fostering comprehensive management and integration.", "x-allOf-name": "os.Catalog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Catalog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Catalog" ], "default": "os.Catalog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Catalog" ], "default": "os.Catalog", "x-enum-as-string": true }, "Name": { "description": "The catalog name. There will be one for system and one for each user account.", "type": "string", "x-omitempty": true }, "ConfigurationFiles": { "description": "An array of relationships to osConfigurationFile resources.", "type": "array", "items": { "$ref": "#/components/schemas/os.ConfigurationFile.Relationship" }, "nullable": true }, "Distributions": { "description": "An array of relationships to osDistribution resources.", "type": "array", "items": { "$ref": "#/components/schemas/os.Distribution.Relationship" }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "os.Catalog.List": { "title": "List of 'os.Catalog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.Catalog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.Catalog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.Catalog" }, "nullable": true } } } ] }, "os.ConfigurationFile.Response": { "description": "The response body of a HTTP GET request for the 'os.ConfigurationFile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.ConfigurationFile' resources.", "x-one-of-name": "os.ConfigurationFile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.ConfigurationFile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.ConfigurationFile.Relationship": { "description": "A relationship to the 'os.ConfigurationFile' resource, or the expanded 'os.ConfigurationFile' resource, or the 'null' value.", "x-one-of-name": "os.ConfigurationFile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/os.ConfigurationFile" } ], "discriminator": { "propertyName": "ClassId" } }, "os.ConfigurationFile": { "title": "Operating System Configuration File", "description": "ConfigurationFiles are operating system \u201canswer files\u201d used to enable unattended OS installation (for example, kickstart, unattended XML, or cloud-init/seed-style files). A ConfigurationFile can be either a static file or a template containing placeholders that are resolved at install time.\n#### Purpose\nProvide reusable, centrally managed OS installation configuration content\u2014either as fixed answers or parameterized templates\u2014so OS installs can be automated consistently across servers.\n#### Key Concepts\n- **Unattended install enablement**: Stores OS-specific answer content used by installation workflows.\n- **Template support with placeholders**: `fileContent` may use Go `text/template` syntax; `placeholders` exposes detected placeholder names so UIs/workflows can collect required inputs dynamically.\n- **Pre-canned vs user-defined entries**: `supported` distinguishes Intersight-provided, QA-validated templates from user-created ones; `internal` can mark wizard-uploaded files that should not appear in general management views.\n- **OS applicability mapping**: `distributions` links the configuration file to one or more supported OS distributions (`hcl.OperatingSystem`).\n- **Licensed capability**: CRUD operations require the Advantage entitlement.\n- **Stable identity**: Identified by `name` (and `catalog` as part of identity in the model), enabling consistent referencing.", "x-allOf-name": "os.ConfigurationFile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.ConfigurationFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.ConfigurationFile" ], "default": "os.ConfigurationFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.ConfigurationFile" ], "default": "os.ConfigurationFile", "x-enum-as-string": true }, "Description": { "description": "Description of the OS ConfigurationFile.", "type": "string", "x-omitempty": true }, "FileContent": { "description": "The content of the entire configuration file is stored as value. The content\ncan either be a static file content or a template content.\nThe template is expected to conform to the golang template syntax. The values\nfrom os.Answers properties will be used to populate this template.", "type": "string", "x-omitempty": true }, "Internal": { "description": "The internal flag is set to true when configuration file is uploaded from OS Install wizard. Internal Configuration files will not be displayed in Answer Management Page.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "The name of the OS ConfigurationFile that uniquely identifies the configuration file.", "type": "string", "pattern": "^[a-zA-Z0-9\\._\\-]+$", "maxLength": 64, "x-omitempty": true }, "Placeholders": { "type": "array", "items": { "description": "This readonly property holds the list of placeholder names used in the\nconfiguration file content in case it is a template.", "$ref": "#/components/schemas/os.PlaceHolder", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Supported": { "description": "An internal property that is used to distinguish between the pre-canned OS\nconfiguration file entries and user provided entries.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Catalog": { "$ref": "#/components/schemas/os.Catalog.Relationship", "description": "A reference to a osCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Distributions": { "description": "An array of relationships to hclOperatingSystem resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/hcl.OperatingSystem.Relationship" }, "nullable": true } } } ] }, "os.ConfigurationFile.List": { "title": "List of 'os.ConfigurationFile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.ConfigurationFile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.ConfigurationFile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.ConfigurationFile" }, "nullable": true } } } ] }, "os.Distribution.Response": { "description": "The response body of a HTTP GET request for the 'os.Distribution' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.Distribution' resources.", "x-one-of-name": "os.Distribution.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.Distribution.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.Distribution.Relationship": { "description": "A relationship to the 'os.Distribution' resource, or the expanded 'os.Distribution' resource, or the 'null' value.", "x-one-of-name": "os.Distribution.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/os.Distribution" } ], "discriminator": { "propertyName": "ClassId" } }, "os.Distribution": { "title": "Os:Distribution", "description": "The Distribution object encompasses the details of operating system distributions that are validated and supported by Intersight for automated installation. It acts as a repository of supported OS versions and their associated metadata.\n#### Purpose\nDistribution objects serve as a reference for all supported operating system distributions within Intersight, ensuring compatibility and reliability of automated installations. They provide essential metadata required for managing and deploying these OS distributions efficiently.\n#### Key Concepts\n- **OS Validation:** Contains validated OS distribution details, ensuring reliability and compatibility with Intersight's automated installation services.\n- **Intersight-Supported:** Lists OS distributions that are officially supported for automated installation, backed by thorough validation processes.\n- **Integration with Configuration Files:** Works in conjunction with OS configuration files and post-install scripts to facilitate seamless installation processes.\n- **Access Control:** Privileges such as System Administrator and Account Administrator ensure secure access and management of distribution details.", "x-allOf-name": "os.Distribution", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Distribution', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Distribution" ], "default": "os.Distribution", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Distribution" ], "default": "os.Distribution", "x-enum-as-string": true }, "IsSupported": { "description": "An internal property that is used to denote if the OS Distribution is supported\nby Intersight for Automated Installation.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Label": { "description": "The label of the OS distribution such as ESXi, CentOS to be displayed.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the OS distribution such as ESXi, CentOS.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ScuSupported": { "description": "An internal property that is used to denote if the OS Distribution is supported\nby the Server Configuration Utility.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SupportedEditions": { "type": "array", "items": { "description": "A Collection of all the Editions of the OS Distribution that is\nsupported within Intersight.\nEditions available with OS Vendor but not available in this list are not supported\nfor OS Installation through Intersight.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Catalog": { "$ref": "#/components/schemas/os.Catalog.Relationship", "description": "A reference to a osCatalog resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Vendor": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/hcl.OperatingSystemVendor.Relationship", "description": "A reference to a hclOperatingSystemVendor resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Version": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/hcl.OperatingSystem.Relationship", "description": "A reference to a hclOperatingSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "os.Distribution.List": { "title": "List of 'os.Distribution' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.Distribution' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.Distribution' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.Distribution" }, "nullable": true } } } ] }, "os.FibreChannelResponse": { "title": "FibreChannel LUN", "description": "FibreChannel LUN response for UI.", "x-allOf-name": "os.FibreChannelResponse", "allOf": [ { "$ref": "#/components/schemas/os.RemoteTargetResponse" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.FibreChannelResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.FibreChannelResponse" ], "default": "os.FibreChannelResponse", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.FibreChannelResponse" ], "default": "os.FibreChannelResponse", "x-enum-as-string": true }, "InitiatorWwpn": { "description": "WWPN address of the underlying fibre channel interface by initator/server for SAN boot. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 20:00:D4:C9:3C:35:02:01.", "type": "string", "pattern": "(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "x-omitempty": true }, "LunId": { "description": "The Logical Unit Number (LUN) of the install target.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "TargetWwpn": { "description": "WWPN address of the underlying fibre channel interface by target/storage for SAN boot. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 51:4F:0C:50:14:1F:AF:01.", "type": "string", "pattern": "(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "x-omitempty": true } } } ] }, "os.FibreChannelTarget": { "title": "Fibre Channel Target", "description": "Fibre Channel target to install Operating System.", "x-allOf-name": "os.FibreChannelTarget", "allOf": [ { "$ref": "#/components/schemas/os.SanTarget" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.FibreChannelTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.FibreChannelTarget" ], "default": "os.FibreChannelTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.FibreChannelTarget" ], "default": "os.FibreChannelTarget", "x-enum-as-string": true }, "InitiatorWwpn": { "description": "The WWPN Address of the underlying fibre channel interface at initator used for SAN boot. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 20:00:D4:C9:3C:35:02:01.", "type": "string", "pattern": "(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "x-omitempty": true }, "LunId": { "description": "Logical Unit Number (LUN) of the install target.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "TargetWwpn": { "description": "The WWPN Address of the underlying fibre channel interface at target used by the SAN boot device. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 51:4F:0C:50:14:1F:AF:01.", "type": "string", "pattern": "(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "x-omitempty": true } } } ] }, "os.GlobalConfig": { "title": "Os:Global Config", "description": "The Global configuration parameter for the uploaded CSV file for OS Install.", "x-allOf-name": "os.GlobalConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.GlobalConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.GlobalConfig" ], "default": "os.GlobalConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.GlobalConfig" ], "default": "os.GlobalConfig", "x-enum-as-string": true }, "ConfigurationFileName": { "description": "Name of the Configuration file.", "type": "string", "pattern": "^$|^[a-zA-Z0-9\\._\\-]+$", "maxLength": 64, "readOnly": true, "x-omitempty": true }, "ConfigurationSource": { "description": "Configuration source for the OS Installation.", "type": "string", "readOnly": true, "x-omitempty": true }, "InstallMethod": { "description": "The install method to be used for OS installation - vMedia, iPXE.\nOnly vMedia is supported as of now.", "type": "string", "readOnly": true, "x-omitempty": true }, "InstallTargetType": { "description": "The Prefill install Target Name.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperatingSystemParameters": { "description": "Parameters specific to selected OS.", "$ref": "#/components/schemas/os.OperatingSystemParameters", "readOnly": true, "x-omitempty": true }, "OsImageName": { "description": "The Operating System Image name.", "type": "string", "readOnly": true, "x-omitempty": true }, "OverrideSecureBoot": { "description": "ESXi Secure Boot installation is currently not supported. As a workaround, Secure Boot will be disabled before installation and restored after installation is complete. Enable to Override Secure Boot Configuration.", "type": "boolean", "default": false, "x-omitempty": true }, "ScuImageName": { "description": "The name of the Server Configuration Utilities Image.", "type": "string", "readOnly": true, "x-omitempty": true }, "WindowsEdition": { "description": "The Windows OS edition, this property required only for Windows server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "os.Install.Response": { "description": "The response body of a HTTP GET request for the 'os.Install' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.Install' resources.", "x-one-of-name": "os.Install.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.Install.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.Install": { "title": "OS Install", "description": "The Install object is the execution point for initiating operating system installations on target servers. It models the necessary configuration and relationships required to start OS installations through Intersight's workflow system.\n#### Purpose\nThe Install object captures all required properties and relationships for initiating OS installations. It acts as a launch point for installation workflows, ensuring that all necessary configurations are validated and tracked through Intersight's workflow engine.\n#### Key Concepts\n- **Workflow Integration:** Initiates OS installation workflows, allowing tracking and management through the workflow engine.\n- **Configuration Management:** Encapsulates all necessary installation configurations, ensuring comprehensive setup before deployment.\n- **Access Control:** Enforces privilege sets such as Account Administrator and Manage Servers, safeguarding the initiation and management of installations.\n- **Relationship Management:** Links to critical components such as OS images and configuration files, ensuring seamless installation processes.", "x-allOf-name": "os.Install", "allOf": [ { "$ref": "#/components/schemas/os.BaseInstallConfig" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Install', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Install" ], "default": "os.Install", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Install" ], "default": "os.Install", "x-enum-as-string": true }, "Name": { "description": "The name of the OS install configuration.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "ConfigurationFile": { "$ref": "#/components/schemas/os.ConfigurationFile.Relationship", "description": "A reference to a osConfigurationFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Image": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/softwarerepository.OperatingSystemFile.Relationship", "description": "A reference to a softwarerepositoryOperatingSystemFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "OsduImage": { "$ref": "#/components/schemas/firmware.ServerConfigurationUtilityDistributable.Relationship", "description": "A reference to a firmwareServerConfigurationUtilityDistributable resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "WorkflowInfo": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "os.Install.List": { "title": "List of 'os.Install' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.Install' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.Install' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.Install" }, "nullable": true } } } ] }, "os.InstallTarget": { "title": "Os:Install Target", "description": "Install Target upon which Operating System is installed.", "x-allOf-name": "os.InstallTarget", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "os.InstallTargetResponse": { "title": "Os:Install Target Response", "description": "Install target generic type for the flat array for Orchestration UI.", "x-allOf-name": "os.InstallTargetResponse", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.InstallTargetResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.PhysicalDiskResponse", "os.VirtualDriveResponse" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.PhysicalDiskResponse", "os.VirtualDriveResponse" ], "x-enum-as-string": true }, "SourceMo": { "description": "Mo Reference of the LUN in CmRf format.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true } } } ] }, "os.IpConfiguration": { "title": "Os:Ip Configuration", "description": "The IP configuration used to configure Static IPv4/IPv6 configurations.", "x-allOf-name": "os.IpConfiguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "os.Ipv4Configuration": { "title": "IPv4 Configuration", "description": "In case of static IPv4 configuration, IP address, netmask and gateway details are provided.", "x-allOf-name": "os.Ipv4Configuration", "allOf": [ { "$ref": "#/components/schemas/os.IpConfiguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Ipv4Configuration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Ipv4Configuration" ], "default": "os.Ipv4Configuration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Ipv4Configuration" ], "default": "os.Ipv4Configuration", "x-enum-as-string": true }, "IpV4Config": { "description": "In case of static IP configuration, IP address, netmask and gateway details are\nprovided.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV4Interface", "x-omitempty": true } } } ] }, "os.Ipv6Configuration": { "title": "IPv6 Configuration", "description": "In case of static IPv6 configuration, IP address, netmask and gateway details are provided.", "x-allOf-name": "os.Ipv6Configuration", "allOf": [ { "$ref": "#/components/schemas/os.IpConfiguration" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.Ipv6Configuration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.Ipv6Configuration" ], "default": "os.Ipv6Configuration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.Ipv6Configuration" ], "default": "os.Ipv6Configuration", "x-enum-as-string": true }, "IpV6Config": { "description": "In case of static IP configuration, IP address, netmask and gateway details are\nprovided.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.IpV6Interface", "x-omitempty": true } } } ] }, "os.IscsiLunResponse": { "title": "ISCSI LUN", "description": "ISCSI LUN response for UI.", "x-allOf-name": "os.IscsiLunResponse", "allOf": [ { "$ref": "#/components/schemas/os.RemoteTargetResponse" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.IscsiLunResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.IscsiLunResponse" ], "default": "os.IscsiLunResponse", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.IscsiLunResponse" ], "default": "os.IscsiLunResponse", "x-enum-as-string": true }, "LunId": { "description": "The Logical Unit Number (LUN) of the install target.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "TargetIqn": { "description": "IQN (iSCSI qualified name) of Storage iSCSI target. Can be up to 255 characters long and has the following format, iqn.yyyy-mm.naming-authority:unique_name.", "type": "string", "pattern": "^(iqn\\.(\\d{4}-(0[1-9]|1[0-2]))\\.([a-zA-Z0-9]+)([a-zA-Z0-9-.]*)(:)+([^,\\s']+))$", "x-omitempty": true }, "VnicMac": { "description": "MAC address of the VNIC to be used as initiator iSCSI interface.", "type": "string", "pattern": "^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$", "x-omitempty": true } } } ] }, "os.IscsiTarget": { "title": "iSCSI Target", "description": "ISCSI LUN to install Operating System.", "x-allOf-name": "os.IscsiTarget", "allOf": [ { "$ref": "#/components/schemas/os.SanTarget" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.IscsiTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.IscsiTarget" ], "default": "os.IscsiTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.IscsiTarget" ], "default": "os.IscsiTarget", "x-enum-as-string": true }, "LunId": { "description": "The Logical Unit Number (LUN) of the install target.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "x-omitempty": true }, "TargetIqn": { "description": "IQN (iSCSI qualified name) of Storage iSCSI target.Can be up to 255 characters long and has the following format, iqn.yyyy-mm.naming-authority:unique_name.", "type": "string", "pattern": "^(iqn\\.(\\d{4}-(0[1-9]|1[0-2]))\\.([a-zA-Z0-9]+)([a-zA-Z0-9-.]*)(:)+([^,\\s']+))$", "x-omitempty": true }, "VnicMac": { "description": "MAC address of the VNIC used as iSCSI initiator interface.", "type": "string", "pattern": "^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$", "x-omitempty": true } } } ] }, "os.OperatingSystemParameters": { "title": "Os:Operating System Parameters", "description": "Installation parameters specific to selected OS.", "x-allOf-name": "os.OperatingSystemParameters", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "os.OsSupport": { "title": "Os:Os Support", "description": "The OsSupport object is designed to validate the support status of a specific operating system version within Intersight. It ensures compatibility and readiness of OS versions for installation processes.\n#### Purpose\nOsSupport provides validation for operating system versions, confirming their compatibility with Intersight's installation services. It is essential for maintaining reliability and ensuring that only supported OS versions are utilized in installation configurations.\n#### Key Concepts\n- **Version Validation:** Confirms compatibility of OS versions, ensuring they meet the criteria for support within Intersight.\n- **Access Control:** Privilege sets such as Account Administrator and Manage Servers guarantee secure validation processes.\n- **Integration with HCL:** Works in conjunction with Hardware Compatibility Lists (HCL) to verify version support, maintaining alignment with hardware r requirements.", "x-allOf-name": "os.OsSupport", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.OsSupport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.OsSupport" ], "default": "os.OsSupport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.OsSupport" ], "default": "os.OsSupport", "x-enum-as-string": true }, "OsVersion": { "description": "The version of the Operating System to be validated. The version should be as per HCL.", "type": "string", "x-createOnly": true, "x-omitempty": true } } } ] }, "os.PhysicalDisk": { "title": "Physical Disk", "description": "Physical Disk target to do Operating System installation on.", "x-allOf-name": "os.PhysicalDisk", "allOf": [ { "$ref": "#/components/schemas/os.InstallTarget" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.PhysicalDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.PhysicalDisk" ], "default": "os.PhysicalDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.PhysicalDisk" ], "default": "os.PhysicalDisk", "x-enum-as-string": true }, "Name": { "description": "The Physical Disk Name to be used as Install Target.", "type": "string", "x-omitempty": true }, "SerialNumber": { "description": "Serial Number of the Physical Disk Target.", "type": "string", "x-omitempty": true }, "StorageControllerSlotId": { "description": "The SlotID of the Storage Controller associated to the physical disk.", "type": "string", "x-omitempty": true } } } ] }, "os.PhysicalDiskResponse": { "title": "Physical Disk", "description": "Physical Disk target entry for the UI.", "x-allOf-name": "os.PhysicalDiskResponse", "allOf": [ { "$ref": "#/components/schemas/os.InstallTargetResponse" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.PhysicalDiskResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.PhysicalDiskResponse" ], "default": "os.PhysicalDiskResponse", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.PhysicalDiskResponse" ], "default": "os.PhysicalDiskResponse", "x-enum-as-string": true }, "Bootable": { "description": "Bootable field of the Physical Drive target.", "type": "string", "x-omitempty": true }, "Name": { "description": "The Physical Disk Name to be used as Install Target.", "type": "string", "x-omitempty": true }, "SerialNumber": { "description": "Serial Number of the Physical Disk Target.", "type": "string", "x-omitempty": true }, "StorageControllerSlotId": { "description": "The Storage Controller associated to the physical disk.", "type": "string", "x-omitempty": true } } } ] }, "os.PlaceHolder": { "title": "Os:Place Holder", "description": "Definition for place holders in templates/post install scripts.", "x-allOf-name": "os.PlaceHolder", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.PlaceHolder', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.PlaceHolder" ], "default": "os.PlaceHolder", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.PlaceHolder" ], "default": "os.PlaceHolder", "x-enum-as-string": true }, "IsValueSet": { "description": "Flag to indicate if value is set. Value will be used to check if any edit.", "type": "boolean", "default": true, "x-omitempty": true }, "Type": { "description": "Definition of place holder.", "nullable": true, "x-omitempty": true }, "Value": { "description": "Value for placeholder provided by user.", "nullable": true, "x-omitempty": true } } } ] }, "os.RemoteTargetResponse": { "title": "Os:Remote Target Response", "description": "Remote Install target type for the flat array for Orchestration UI.", "x-allOf-name": "os.RemoteTargetResponse", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.RemoteTargetResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.FibreChannelResponse", "os.IscsiLunResponse" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "os.FibreChannelResponse", "os.IscsiLunResponse" ], "x-enum-as-string": true }, "InterfaceName": { "description": "Interface name of the iSCSI/FC used as initiator.", "type": "string", "x-omitempty": true } } } ] }, "os.SanTarget": { "title": "Os:San Target", "description": "Remote LUN target to install Operating System.", "x-allOf-name": "os.SanTarget", "allOf": [ { "$ref": "#/components/schemas/os.InstallTarget" } ] }, "os.ServerConfig": { "title": "Os:Server Config", "description": "The server level OS install parameter for the uploaded CSV file.", "x-allOf-name": "os.ServerConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.ServerConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.ServerConfig" ], "default": "os.ServerConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.ServerConfig" ], "default": "os.ServerConfig", "x-enum-as-string": true }, "AdditionalParameters": { "type": "array", "items": { "description": "If the os.ConfigurationFile MO selected is a template that uses additional\nplaceholders other than the ones provided in standard os.Answers MO, the values\nfor those additional placeholders are provided here.", "$ref": "#/components/schemas/os.PlaceHolder", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Answers": { "description": "Answers provided by user for the unattended OS installation.", "$ref": "#/components/schemas/os.Answers", "readOnly": true, "x-omitempty": true }, "ErrorMsgs": { "type": "array", "items": { "description": "Validation error messages.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "InitiatorWwpn": { "description": "The WWPN Address of the underlying fibre channel interface at the host side used for SAN accesss. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 20:00:D4:C9:3C:35:02:01.", "type": "string", "pattern": "^$|(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "readOnly": true, "x-omitempty": true }, "InstallTarget": { "description": "The target in which OS installation triggered, the value represented is StorageControllerID follwed by PhysicalDisk SerialNumber in case of Physcial disk or VirtualDriveId for virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "LunId": { "description": "The Logical Unit Number (LUN) of the install target.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 255, "readOnly": true, "x-omitempty": true }, "OperatingSystemParameters": { "description": "Parameters specific to selected OS.", "$ref": "#/components/schemas/os.OperatingSystemParameters", "readOnly": true, "x-omitempty": true }, "ProcessedInstallTarget": { "description": "The target in which OS installation triggered, this is populated after processing the given data.", "$ref": "#/components/schemas/os.InstallTarget", "readOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "The Serial Number of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetIqn": { "description": "IQN (iSCSI qualified name) of Storage iSCSI target. Can be up to 255 characters long and has the following format, iqn.yyyy-mm.naming-authority:unique_name.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetWwpn": { "description": "The WWPN Address of the underlying fibre channel interface at the target used by the storage. Value must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. For example, 51:4F:0C:50:14:1F:AF:01.", "type": "string", "pattern": "^$|(^([0-9a-fA-F]{2}:){7}[0-9a-fA-F]{2}$)", "readOnly": true, "x-omitempty": true }, "VnicMac": { "description": "MAC address of the VNIC used as iSCSI initiator interface.", "type": "string", "pattern": "^$|^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$", "readOnly": true, "x-omitempty": true } } } ] }, "os.SupportedVersion.Response": { "description": "The response body of a HTTP GET request for the 'os.SupportedVersion' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.SupportedVersion' resources.", "x-one-of-name": "os.SupportedVersion.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.SupportedVersion.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.SupportedVersion": { "title": "Os:Supported Version", "description": "The SupportedVersion object provides information on operating system versions supported by the Server Configuration Utility (SCU). It is essential for UI operations and aids in filtering OS configurations based on vendor and version.\n#### Purpose\nSupportedVersion serves as a reference for operating system versions that are supported by SCU, ensuring that users can easily identify compatible versions for installation processes. It aids in UI operations by providing clear and concise version information.\n#### Key Concepts\n- **Version Reference:** Provides a list of supported OS versions by SCU, enabling users to select compatible configurations.\n- **Vendor Integration:** Filters OS versions based on vendor, ensuring alignment with vendor-specific requirements.\n- **Access Control:** Privilege sets such as Account Administrator and Manage Servers ensure secure access and management of version information.\n- **UI Operations:** Facilitates UI operations by providing essential version information, supporting efficient configuration and deployment processes.", "x-allOf-name": "os.SupportedVersion", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.SupportedVersion', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.SupportedVersion" ], "default": "os.SupportedVersion", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.SupportedVersion" ], "default": "os.SupportedVersion", "x-enum-as-string": true }, "FilterOptions": { "description": "The OsInstall Supported Operating System Version Filter Option.\n* `None` - No filtering is applied, allowing all available OS versions.\n* `SupportedInBlueprint` - Restricts the OS version specific to blueprint.", "type": "string", "enum": [ "None", "SupportedInBlueprint" ], "default": "None", "readOnly": true, "x-omitempty": true }, "VersionName": { "description": "The OsInstall Supported Operating System Version Name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/hcl.OperatingSystemVendor.Relationship", "description": "A reference to a hclOperatingSystemVendor resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Version": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/hcl.OperatingSystem.Relationship", "description": "A reference to a hclOperatingSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "os.SupportedVersion.List": { "title": "List of 'os.SupportedVersion' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.SupportedVersion' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.SupportedVersion' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.SupportedVersion" }, "nullable": true } } } ] }, "os.TemplateFile": { "title": "Os:Template File", "description": "The TemplateFile object is a specialized component that encapsulates OS-specific answer files for unattended installations. It supports both static and template-based content, utilizing golang template syntax.\n#### Purpose\nTemplateFile objects provide customizable OS installation configurations through answer files, supporting unattended installation processes. They allow users to define installation parameters using static content or dynamic templates with placeholders.\n#### Key Concepts\n- **Unattended Installations:** Facilitates automated OS installations by providing answer files with predefined parameters.\n- **Template Support:** Utilizes golang template syntax to allow dynamic content creation with placeholders.\n- **Customization:** Enables users to tailor installation configurations, supporting unique requirements and environments.\n- **Access Control:** Privilege sets such as Account Administrator and Manage Servers ensure secure creation and management of template files.", "x-allOf-name": "os.TemplateFile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.TemplateFile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.TemplateFile" ], "default": "os.TemplateFile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.TemplateFile" ], "default": "os.TemplateFile", "x-enum-as-string": true }, "Name": { "description": "The name of the OS Template File that user uploads for unattended installation.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Placeholders": { "type": "array", "items": { "description": "This readonly property holds the list of placeholder names used in the\ntemplate file content.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateContent": { "description": "The content of the entire template file is stored as value. The content\ncan either be a static file content or a template content.\nThe template is expected to conform to the golang template syntax. \nThe placeholders, if any, would be populated and the values provided would be \nused to populate this template.", "type": "string", "x-omitempty": true } } } ] }, "os.ValidInstallTarget": { "title": "Os:Valid Install Target", "description": "ValidInstallTargets are on-demand \u201cdiscovery response\u201d objects used to fetch and return the set of valid local install targets for one or more servers. The results include both Physical Disks and Virtual Drives, grouped by controller/drive type and optionally also returned as a flat list for UI consumption.\n#### Purpose\nAllow OS installation workflows to query which local storage targets are suitable for installation on the specified servers, returning validated choices to drive an install wizard or automation.\n#### Key Concepts\n- **Action-style request/response**: Invoked via CREATE to trigger target discovery/validation for the specified `servers`.\n- **Controller/drive-type grouping**: Provides categorized collections such as `mraidVirtualDrives`, `mraidJbod`, `m2VirtualDrives`, `u2Nvme`, `e3sNvme`, `e1sNvme`, `mstorNvme`, and NVMe RAID variants.\n- **Flat-list UI mode**: `src` can indicate orchestration UI usage; `installTargets` offers a generic flat list (`InstallTargetResponse`) for simplified consumption.\n- **Error reporting**: `error` captures validation/discovery failures encountered while retrieving install targets.\n- **Server-scoped evaluation**: `servers` (create-only) defines which compute.Physical endpoints are evaluated.", "x-allOf-name": "os.ValidInstallTarget", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.ValidInstallTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.ValidInstallTarget" ], "default": "os.ValidInstallTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.ValidInstallTarget" ], "default": "os.ValidInstallTarget", "x-enum-as-string": true }, "E1sNvme": { "type": "array", "items": { "description": "A Collection of valid E1.S NVME targets of NVMe storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "E3sNvme": { "type": "array", "items": { "description": "A Collection of valid E3.S NVME targets of NVMe storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Error": { "description": "Error message if any errors are encountered while fetching and validating Install targets for the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "InstallTargets": { "type": "array", "items": { "description": "A Collection of all valid Install targets represented as a flat list.", "$ref": "#/components/schemas/os.InstallTargetResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "M2Jbod": { "type": "array", "items": { "description": "A Collection of valid Physical Disk targets of M.2-HWRAID storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "M2NvmeRaidJbod": { "type": "array", "items": { "description": "A Collection of valid Physical Disk targets of M.2 NVME-RAID storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "M2NvmeRaidVirtualDrives": { "type": "array", "items": { "description": "A Collection of valid Virtual Drive targets of M.2 NVME-RAID storage Controllers.", "$ref": "#/components/schemas/os.VirtualDriveResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "M2VirtualDrives": { "type": "array", "items": { "description": "A Collection of valid Virtual Drive targets of M.2-HWRAID storage Controllers.", "$ref": "#/components/schemas/os.VirtualDriveResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MraidJbod": { "type": "array", "items": { "description": "A Collection of valid Physical Disk targets of MRAID storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MraidVirtualDrives": { "type": "array", "items": { "description": "A Collection of valid Virtual Drive targets of MRAID storage Controllers.", "$ref": "#/components/schemas/os.VirtualDriveResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "MstorNvme": { "type": "array", "items": { "description": "A Collection of valid MSTOR NVME targets of MSTOR NVMe storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Src": { "description": "Flag to denote the source of the request.\nIf the call is from Orchestration UI, only the flat list of Install targets can be sent as response.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "U2Nvme": { "type": "array", "items": { "description": "A Collection of valid U.2 NVME targets of NVMe storage Controllers.", "$ref": "#/components/schemas/os.PhysicalDiskResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Servers": { "description": "An array of relationships to computePhysical resources.", "type": "array", "items": { "$ref": "#/components/schemas/compute.Physical.Relationship" }, "nullable": true, "x-createOnly": true } } } ] }, "os.ValidRemoteTarget.Response": { "description": "The response body of a HTTP GET request for the 'os.ValidRemoteTarget' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'os.ValidRemoteTarget' resources.", "x-one-of-name": "os.ValidRemoteTarget.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/os.ValidRemoteTarget.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "os.ValidRemoteTarget": { "title": "Os:Valid Remote Target", "description": "ValidRemoteTargets provide validated remote boot/install targets for a server based on its server profile, focusing on SAN/iSCSI paths. The results enumerate reachable Fibre Channel LUNs and iSCSI LUNs that can be used as remote install targets.\n#### Purpose\nEnable OS installation workflows to discover and present valid remote installation targets (SAN boot style) derived from the server\u2019s configured profile connectivity.\n#### Key Concepts\n- **Read-based retrieval**: Exposed via READ to fetch current valid remote target options.\n- **Remote target types**: Returns `fibreChannelLuns` (with initiator/target WWPNs and LUN ID constraints) and `iscsiLuns` (with initiator vNIC MAC and target IQN validation).\n- **Profile-derived paths**: Targets are determined from the server profile configuration associated with the server.\n- **Server association**: `server` identifies the compute.Physical for which remote targets are being reported.\n- **UI-oriented response shaping**: `src` can indicate orchestration UI usage patterns for response formatting.", "x-allOf-name": "os.ValidRemoteTarget", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.ValidRemoteTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.ValidRemoteTarget" ], "default": "os.ValidRemoteTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.ValidRemoteTarget" ], "default": "os.ValidRemoteTarget", "x-enum-as-string": true }, "FibreChannelLuns": { "type": "array", "items": { "description": "A Collection of fibre channel LUNs.", "$ref": "#/components/schemas/os.FibreChannelResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IscsiLuns": { "type": "array", "items": { "description": "A Collection of iSCSI LUNs.", "$ref": "#/components/schemas/os.IscsiLunResponse", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Src": { "description": "Flag to denote the source of the request.\nIf the call is from Orchestration UI, only the flat list of Install targets can be sent as response.", "type": "string", "x-createOnly": true, "x-omitempty": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "os.ValidRemoteTarget.List": { "title": "List of 'os.ValidRemoteTarget' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'os.ValidRemoteTarget' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'os.ValidRemoteTarget' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/os.ValidRemoteTarget" }, "nullable": true } } } ] }, "os.ValidationInformation": { "title": "Os:Validation Information", "description": "Used to show the state of the CSV validaton and its state.", "x-allOf-name": "os.ValidationInformation", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.ValidationInformation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.ValidationInformation" ], "default": "os.ValidationInformation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.ValidationInformation" ], "default": "os.ValidationInformation", "x-enum-as-string": true }, "ErrorMsg": { "description": "Validation error message.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "The status of the validation step.\n* `NotValidated` - The validation not started.\n* `Valid` - The step status marked as valid when respective step validation condition is successful.\n* `Invalid` - The step status marked as invalid when respective step validation condition is failed.\n* `InProgress` - The validation is in progress.", "type": "string", "enum": [ "NotValidated", "Valid", "Invalid", "InProgress" ], "default": "NotValidated", "readOnly": true, "x-omitempty": true }, "StepName": { "description": "The validation step name.\n* `OS Install Schema Validation` - The step to validate the CSV file schema.\n* `OS Image Validation` - The Operating System Image parameter validation step.\n* `SCU Image Validation` - The SCU Image parameter validation step.\n* `Configuration source and file validation` - The Configuration Source and Configuration file validation step.\n* `Server level data validation` - The server level parameters validation.", "type": "string", "enum": [ "OS Install Schema Validation", "OS Image Validation", "SCU Image Validation", "Configuration source and file validation", "Server level data validation" ], "default": "OS Install Schema Validation", "readOnly": true, "x-omitempty": true } } } ] }, "os.VirtualDrive": { "title": "Virtual Drive", "description": "Virtual Drive target to do Operating System installation on.", "x-allOf-name": "os.VirtualDrive", "allOf": [ { "$ref": "#/components/schemas/os.InstallTarget" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.VirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.VirtualDrive" ], "default": "os.VirtualDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.VirtualDrive" ], "default": "os.VirtualDrive", "x-enum-as-string": true }, "Id": { "description": "Virtual Drive ID to be used as Install Target.", "type": "string", "x-omitempty": true }, "Name": { "description": "The Virtual Drive Name to be used as Install Target.", "type": "string", "x-omitempty": true }, "StorageControllerSlotId": { "description": "The SlotID of the Storage Controller associated to the virtual drive.", "type": "string", "x-omitempty": true } } } ] }, "os.VirtualDriveResponse": { "title": "Virtual Drive", "description": "Virtual Drive target entry for the UI.", "x-allOf-name": "os.VirtualDriveResponse", "allOf": [ { "$ref": "#/components/schemas/os.InstallTargetResponse" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.VirtualDriveResponse', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.VirtualDriveResponse" ], "default": "os.VirtualDriveResponse", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.VirtualDriveResponse" ], "default": "os.VirtualDriveResponse", "x-enum-as-string": true }, "Bootable": { "description": "Bootable field of the Virtual Drive target.", "type": "string", "x-omitempty": true }, "Id": { "description": "Virtual Drive ID to be used as Install Target.", "type": "string", "x-omitempty": true }, "Name": { "description": "The Virtual Drive Name to be used as Install Target.", "type": "string", "x-omitempty": true }, "StorageControllerSlotId": { "description": "The Storage Controller associated to the virtual drive.", "type": "string", "x-omitempty": true } } } ] }, "os.VmwareParameters": { "title": "VMware Parameters", "description": "Installation parameters specific to VMware ESXi.", "x-allOf-name": "os.VmwareParameters", "allOf": [ { "$ref": "#/components/schemas/os.OperatingSystemParameters" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.VmwareParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.VmwareParameters" ], "default": "os.VmwareParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.VmwareParameters" ], "default": "os.VmwareParameters", "x-enum-as-string": true }, "Vlanid": { "description": "Specify the VLAN ID in which the ESXi host is turned on. Valid values ranges between 1 \u2013 4095.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 4095, "x-omitempty": true } } } ] }, "os.WindowsParameters": { "title": "Windows Parameters", "description": "This stores the installation parameters specific to Windows .", "x-allOf-name": "os.WindowsParameters", "allOf": [ { "$ref": "#/components/schemas/os.OperatingSystemParameters" }, { "type": "object", "description": "Definition of the list of properties defined in 'os.WindowsParameters', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "os.WindowsParameters" ], "default": "os.WindowsParameters", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "os.WindowsParameters" ], "default": "os.WindowsParameters", "x-enum-as-string": true }, "Edition": { "description": "Lists all the editions supported for Windows Server installation.\n* `Standard` - Windows Standard Edition ideal for advanced features with limited virtualization.\n* `StandardCore` - Windows Standard Core Edition is a minimal installation option while installing Standard Core that is ideal for advanced features with limited virtualization.\n* `Datacenter` - Windows Standard Core Edition ideal for high requirements on IT workloads with largenumber fo virtual systems.\n* `DatacenterCore` - Windows Datacenter Core Edition is a minimal installation option while installing Datacenter Core that isideal for high requirements on IT workloads with largenumber for virtual systems.\n* `Core` - Microsoft Hyper-V is a native hypervisor to create and run virtual machines.", "type": "string", "enum": [ "Standard", "StandardCore", "Datacenter", "DatacenterCore", "Core" ], "default": "Standard", "x-omitempty": true } } } ] }, "pci.CoprocessorCard.Response": { "description": "The response body of a HTTP GET request for the 'pci.CoprocessorCard' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.CoprocessorCard' resources.", "x-one-of-name": "pci.CoprocessorCard.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.CoprocessorCard.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.CoprocessorCard.Relationship": { "description": "A relationship to the 'pci.CoprocessorCard' resource, or the expanded 'pci.CoprocessorCard' resource, or the 'null' value.", "x-one-of-name": "pci.CoprocessorCard.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.CoprocessorCard" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.CoprocessorCard": { "title": "Pci:Coprocessor Card", "description": "PCIe Compression and Cryptographic CPU Offload Card.", "x-allOf-name": "pci.CoprocessorCard", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.CoprocessorCard', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.CoprocessorCard" ], "default": "pci.CoprocessorCard", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.CoprocessorCard" ], "default": "pci.CoprocessorCard", "x-enum-as-string": true }, "CardId": { "description": "The id of the coprocessor card.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The PCI slot name for the coprocessor card.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.CoprocessorCard.List": { "title": "List of 'pci.CoprocessorCard' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.CoprocessorCard' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.CoprocessorCard' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.CoprocessorCard" }, "nullable": true } } } ] }, "pci.Device.Response": { "description": "The response body of a HTTP GET request for the 'pci.Device' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Device' resources.", "x-one-of-name": "pci.Device.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Device.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Device.Relationship": { "description": "A relationship to the 'pci.Device' resource, or the expanded 'pci.Device' resource, or the 'null' value.", "x-one-of-name": "pci.Device.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Device" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Device": { "title": "Pci:Device", "description": "PCI device present in a server.", "x-allOf-name": "pci.Device", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Device', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Device" ], "default": "pci.Device", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Device" ], "default": "pci.Device", "x-enum-as-string": true }, "DeviceId": { "description": "The PCI device id of the PCI device.", "type": "string", "x-omitempty": true }, "FirmwareVersion": { "description": "The running firmware version of the PCI device.", "type": "string", "x-omitempty": true }, "Pid": { "description": "The product identifier of the PCI device.", "type": "string", "x-omitempty": true }, "SlotId": { "description": "The PCI slot id of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Device.List": { "title": "List of 'pci.Device' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Device' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Device' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Device" }, "nullable": true } } } ] }, "pci.Endpoint.Response": { "description": "The response body of a HTTP GET request for the 'pci.Endpoint' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Endpoint' resources.", "x-one-of-name": "pci.Endpoint.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Endpoint.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Endpoint.Relationship": { "description": "A relationship to the 'pci.Endpoint' resource, or the expanded 'pci.Endpoint' resource, or the 'null' value.", "x-one-of-name": "pci.Endpoint.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Endpoint" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Endpoint": { "title": "Pci:Endpoint", "description": "PCIe endpoints that are connected to a PCIe switch.", "x-allOf-name": "pci.Endpoint", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Endpoint', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Endpoint" ], "default": "pci.Endpoint", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Endpoint" ], "default": "pci.Endpoint", "x-enum-as-string": true }, "DeviceEnclosureId": { "description": "The identifier of the enclosure device of the actual physical device to which the logical PCIe endpoint is pointing to.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "The identifier of the actual physical device to which the logical PCIe endpoint is pointing to.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DeviceType": { "description": "The type of the actual physical device to which the logical PCIe endpoint is pointing to.\n* `Unknown` - The device type of the physical device is unknown.\n* `NetworkAdapter` - The device type of the physical device is a NIC adapter.\n* `CPU` - The device type of the physical device is CPU.\n* `GPU` - The device type of the physical device is GPU.", "type": "string", "enum": [ "Unknown", "NetworkAdapter", "CPU", "GPU" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "EndpointId": { "description": "The identifier of the PCIe endpoint within a X-Fabric module PCIe switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the PCIe endpoint, as reported by the XFM platform software (BMC).", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the PCIe endpoint.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of the PCIe endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciSwitch": { "$ref": "#/components/schemas/pci.Switch.Relationship", "description": "A reference to a pciSwitch resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciSwitchPort": { "$ref": "#/components/schemas/pci.Port.Relationship", "description": "A reference to a pciPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciZone": { "$ref": "#/components/schemas/pci.Zone.Relationship", "description": "A reference to a pciZone resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProcessorUnit": { "$ref": "#/components/schemas/processor.Unit.Relationship", "description": "A reference to a processorUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedAdapterUnit": { "$ref": "#/components/schemas/equipment.SharedAdapterUnit.Relationship", "description": "A reference to a equipmentSharedAdapterUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedGraphicsCard": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.Relationship", "description": "A reference to a equipmentSharedGraphicsCard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Endpoint.List": { "title": "List of 'pci.Endpoint' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Endpoint' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Endpoint' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Endpoint" }, "nullable": true } } } ] }, "pci.Link.Response": { "description": "The response body of a HTTP GET request for the 'pci.Link' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Link' resources.", "x-one-of-name": "pci.Link.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Link.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Link.Relationship": { "description": "A relationship to the 'pci.Link' resource, or the expanded 'pci.Link' resource, or the 'null' value.", "x-one-of-name": "pci.Link.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Link" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Link": { "title": "Pci:Link", "description": "The PCI Switch Link connected to PCIe Switch.", "x-allOf-name": "pci.Link", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Link', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Link" ], "default": "pci.Link", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Link" ], "default": "pci.Link", "x-enum-as-string": true }, "Adapter": { "description": "The name of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LinkSpeed": { "description": "The upstream link speed of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LinkStatus": { "description": "The upstream link status of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "LinkWidth": { "description": "The upstream link width of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The slot name of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "SlotStatus": { "description": "The health information of the PCI device.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciSwitch": { "$ref": "#/components/schemas/pci.Switch.Relationship", "description": "A reference to a pciSwitch resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Link.List": { "title": "List of 'pci.Link' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Link' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Link' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Link" }, "nullable": true } } } ] }, "pci.Node.Response": { "description": "The response body of a HTTP GET request for the 'pci.Node' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Node' resources.", "x-one-of-name": "pci.Node.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Node.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Node.Relationship": { "description": "A relationship to the 'pci.Node' resource, or the expanded 'pci.Node' resource, or the 'null' value.", "x-one-of-name": "pci.Node.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Node" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Node": { "title": "Pci:Node", "description": "External PCIe nodes connected to a server.", "x-allOf-name": "pci.Node", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Node', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Node" ], "default": "pci.Node", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Node" ], "default": "pci.Node", "x-enum-as-string": true }, "AlarmSummary": { "description": "The summary of alarm counts based on the severity types (Critical or Warning).", "$ref": "#/components/schemas/compute.AlarmSummary", "readOnly": true, "x-omitempty": true }, "ChassisId": { "description": "The id of the chassis that the PCIe node is currently located in.", "type": "string", "readOnly": true, "x-omitempty": true }, "FirmwareVersion": { "description": "The version of the PCIe node CIMC firmware.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryReady": { "description": "The inventory ready field indicates whether the PCIe node management controller has completed inventory of the installed PCIe devices.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Lifecycle": { "description": "The lifecycle state of the PCIe node. This will map to the discovery lifecycle as represented in the Identity object.\n* `None` - Default state of an equipment. This should be an initial state when no state is defined for an equipment.\n* `Active` - Default Lifecycle State for a physical entity.\n* `Decommissioned` - Decommission Lifecycle state.\n* `SlotReserved` - Blade is inserted in a slot that is reserved for Secure Router.\n* `DiscoveryInProgress` - DiscoveryInProgress Lifecycle state.\n* `DiscoveryFailed` - DiscoveryFailed Lifecycle state.\n* `FirmwareUpgradeInProgress` - Firmware upgrade is in progress on given physical entity.\n* `DiagnosticsInProgress` - Diagnostics is in progress on given physical entity.\n* `SecureEraseInProgress` - Secure Erase is in progress on given physical entity.\n* `ScrubInProgress` - Scrub is in progress on given physical entity.\n* `BladeMigrationInProgress` - Server slot migration is in progress on given physical entity.\n* `SlotMismatch` - The blade server is detected in a different chassis/slot than it was previously.\n* `Removed` - The blade server has been removed from its discovered slot, and not detected anywhere else. Blade inventory can be cleaned up by performing a software remove operation on the physically removed blade.\n* `Moved` - The blade server has been moved from its discovered location to a new location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `Replaced` - The blade server has been removed from its discovered location and another blade has been inserted in that location. Blade inventory can be cleaned up and updated by doing a software remove operation on the physically removed blade.\n* `MovedAndReplaced` - The blade server has been moved from its discovered location to a new location and another blade has been inserted into the old discovered location. Blade inventory can be updated by performing a rediscover operation on the moved blade.\n* `DecommissionAndRemoveInProgress` - Decommission and remove operation is in progress.\n* `DecommissionedForRemove` - Server is decommissioned and once it is physically pulled from chassis, it will be automatically removed from inventory.", "type": "string", "enum": [ "None", "Active", "Decommissioned", "SlotReserved", "DiscoveryInProgress", "DiscoveryFailed", "FirmwareUpgradeInProgress", "DiagnosticsInProgress", "SecureEraseInProgress", "ScrubInProgress", "BladeMigrationInProgress", "SlotMismatch", "Removed", "Moved", "Replaced", "MovedAndReplaced", "DecommissionAndRemoveInProgress", "DecommissionedForRemove" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the PCIe node, the value of this property is the name of the UCS Domain along with the chassis and node slot ids.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the PCIe node.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of the PCIe node.", "type": "string", "readOnly": true, "x-omitempty": true }, "PackageVersion": { "description": "Bundle version which the CIMC firmware belongs to.", "type": "string", "readOnly": true, "x-omitempty": true }, "SlotId": { "description": "The slot number in the chassis that the PCIe node is currently located in.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "GraphicsCards": { "description": "An array of relationships to graphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/graphics.Card.Relationship" }, "nullable": true, "readOnly": true }, "Interconnects": { "description": "An array of relationships to equipmentInterconnect resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.Interconnect.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SharedGraphicsCards": { "description": "An array of relationships to equipmentSharedGraphicsCard resources.", "type": "array", "items": { "$ref": "#/components/schemas/equipment.SharedGraphicsCard.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "pci.Node.List": { "title": "List of 'pci.Node' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Node' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Node' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Node" }, "nullable": true } } } ] }, "pci.NodeSetting.Response": { "description": "The response body of a HTTP GET request for the 'pci.NodeSetting' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.NodeSetting' resources.", "x-one-of-name": "pci.NodeSetting.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.NodeSetting.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.NodeSetting": { "title": "PCIe Node Settings", "description": "Models the configurable properties of a PCIe Node in Intersight.", "x-allOf-name": "pci.NodeSetting", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.NodeSetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.NodeSetting" ], "default": "pci.NodeSetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.NodeSetting" ], "default": "pci.NodeSetting", "x-enum-as-string": true }, "AdminAction": { "description": "User configured action on the PCIe Node.\n* `None` - Placeholder default value for PCIe Node admin state property.\n* `Reboot` - PCIe node reboot state property value.", "type": "string", "enum": [ "None", "Reboot" ], "default": "None", "x-omitempty": true }, "AdminLocatorLedState": { "description": "User configured state of the locator LED for the PCIe Node.\n* `None` - No operation property for locator led.\n* `On` - The Locator Led is turned on.\n* `Off` - The Locator Led is turned off.", "type": "string", "enum": [ "None", "On", "Off" ], "default": "None", "x-omitempty": true }, "ConfigState": { "description": "The configured state of these settings in the target server. The value is any one of Applied, Applying, Failed. Applied - This state denotes that the settings are applied successfully in the target server. Applying - This state denotes that the settings are being applied in the target server. Failed - This state denotes that the settings could not be applied in the target server.\n* `Applied` - User configured settings are in applied state.\n* `Applying` - User settings are being applied on the target server.\n* `Scheduled` - User configured settings are scheduled to be applied.\n* `Failed` - User configured settings could not be applied.", "type": "string", "enum": [ "Applied", "Applying", "Scheduled", "Failed" ], "default": "Applied", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The property used to identify the PCIe node it is associated with.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeOpStatus": { "type": "array", "items": { "description": "The status of actions triggered on the PCIe Node.", "$ref": "#/components/schemas/compute.ServerOpStatus", "readOnly": true, "x-omitempty": true }, "nullable": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciNode": { "$ref": "#/components/schemas/pci.Node.Relationship", "description": "A reference to a pciNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.NodeSetting.List": { "title": "List of 'pci.NodeSetting' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.NodeSetting' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.NodeSetting' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.NodeSetting" }, "nullable": true } } } ] }, "pci.Port.Response": { "description": "The response body of a HTTP GET request for the 'pci.Port' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Port' resources.", "x-one-of-name": "pci.Port.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Port.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Port.Relationship": { "description": "A relationship to the 'pci.Port' resource, or the expanded 'pci.Port' resource, or the 'null' value.", "x-one-of-name": "pci.Port.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Port" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Port": { "title": "Pci:Port", "description": "PCIe Switch port on the PCIe Switch.", "x-allOf-name": "pci.Port", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Port', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Port" ], "default": "pci.Port", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Port" ], "default": "pci.Port", "x-enum-as-string": true }, "Name": { "description": "The name of the PCIe Switch Port. Name will be of the format 'PCIe Port <$id>'.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The health information of the PCIe switch port.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The operational status of the PCIe switch port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "The identifier of the PCIe switch port.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Role": { "description": "The current role of the PCIe switch port.\n* `Unconfigured` - Indicates that the PCIe switch port role is currently unconfigured.\n* `Downstream` - Indicates that the PCIe switch port role is currently downstream. A downstream port connects to a PCIe peripheral device such as a GPU or a network adapter.\n* `Upstream` - Indicates that the PCIe switch port role is currently upstream. An upstream port connects to a PCIe root complex such as a CPU.\n* `Unknown` - Indicates that the PCIe switch port role is currently unknown.", "type": "string", "enum": [ "Unconfigured", "Downstream", "Upstream", "Unknown" ], "default": "Unconfigured", "readOnly": true, "x-omitempty": true }, "Width": { "description": "The link width of the PCIe switch port.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciEndpoint": { "$ref": "#/components/schemas/pci.Endpoint.Relationship", "description": "A reference to a pciEndpoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciSwitch": { "$ref": "#/components/schemas/pci.Switch.Relationship", "description": "A reference to a pciSwitch resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Port.List": { "title": "List of 'pci.Port' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Port' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Port' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Port" }, "nullable": true } } } ] }, "pci.Slot.Response": { "description": "The response body of a HTTP GET request for the 'pci.Slot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Slot' resources.", "x-one-of-name": "pci.Slot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Slot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Slot.Relationship": { "description": "A relationship to the 'pci.Slot' resource, or the expanded 'pci.Slot' resource, or the 'null' value.", "x-one-of-name": "pci.Slot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Slot" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Slot": { "title": "Pci:Slot", "description": "The PCI Slot with Name and Presence details.", "x-allOf-name": "pci.Slot", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Slot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Slot" ], "default": "pci.Slot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Slot" ], "default": "pci.Slot", "x-enum-as-string": true }, "SlotId": { "description": "The Identifier value of the PCI Slot.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Slot.List": { "title": "List of 'pci.Slot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Slot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Slot' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Slot" }, "nullable": true } } } ] }, "pci.Switch.Response": { "description": "The response body of a HTTP GET request for the 'pci.Switch' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Switch' resources.", "x-one-of-name": "pci.Switch.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Switch.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Switch.Relationship": { "description": "A relationship to the 'pci.Switch' resource, or the expanded 'pci.Switch' resource, or the 'null' value.", "x-one-of-name": "pci.Switch.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Switch" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Switch": { "title": "Pci:Switch", "description": "PCIe switch present in the system which connects PCIe devices (CPU, GPU and the PCIe adapter).", "x-allOf-name": "pci.Switch", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Switch', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Switch" ], "default": "pci.Switch", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Switch" ], "default": "pci.Switch", "x-enum-as-string": true }, "DeviceId": { "description": "The device id of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Health": { "description": "The composite health of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumOfAdaptors": { "description": "The number of GPUs and PCIe adapters connected the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational state of the PCIe switch that connects the CPU GPU and the PCIe adapter.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciAddress": { "description": "The PCIe address of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The PCIe slot name of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSwitchId": { "description": "Unique Identifier of a PCIe switch within a chassis expander module.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductName": { "description": "The model information for the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProductRevision": { "description": "The product revision of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubDeviceId": { "description": "The sub device id of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubVendorId": { "description": "The sub vendor id of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Temperature": { "description": "The current temperature of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type information of the switch.", "type": "string", "x-omitempty": true }, "VendorId": { "description": "The vendor id of the switch.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Links": { "description": "An array of relationships to pciLink resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Link.Relationship" }, "nullable": true, "readOnly": true }, "PciEndpoints": { "description": "An array of relationships to pciEndpoint resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Endpoint.Relationship" }, "nullable": true, "readOnly": true }, "Ports": { "description": "An array of relationships to pciPort resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Port.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "pci.Switch.List": { "title": "List of 'pci.Switch' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Switch' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Switch' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Switch" }, "nullable": true } } } ] }, "pci.Zone.Response": { "description": "The response body of a HTTP GET request for the 'pci.Zone' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'pci.Zone' resources.", "x-one-of-name": "pci.Zone.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/pci.Zone.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "pci.Zone.Relationship": { "description": "A relationship to the 'pci.Zone' resource, or the expanded 'pci.Zone' resource, or the 'null' value.", "x-one-of-name": "pci.Zone.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/pci.Zone" } ], "discriminator": { "propertyName": "ClassId" } }, "pci.Zone": { "title": "Pci:Zone", "description": "PCIe endpoints that are zoned (logically connected together) through a PCIe switch.", "x-allOf-name": "pci.Zone", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'pci.Zone', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "pci.Zone" ], "default": "pci.Zone", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "pci.Zone" ], "default": "pci.Zone", "x-enum-as-string": true }, "Name": { "description": "The name of the PCIe endpoint zone, as reported by the platform software (BMC).", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the pcie node.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "Operational state of the pcie node.", "type": "string", "readOnly": true, "x-omitempty": true }, "ZoneId": { "description": "The identifier of the PCIe endpoint zone where all PCIe devices are logically connected.", "type": "string", "readOnly": true, "x-omitempty": true }, "EquipmentExpanderModule": { "$ref": "#/components/schemas/equipment.ExpanderModule.Relationship", "description": "A reference to a equipmentExpanderModule resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PciEndpoints": { "description": "An array of relationships to pciEndpoint resources.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Endpoint.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "pci.Zone.List": { "title": "List of 'pci.Zone' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'pci.Zone' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'pci.Zone' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/pci.Zone" }, "nullable": true } } } ] }, "power.ControlState.Response": { "description": "The response body of a HTTP GET request for the 'power.ControlState' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'power.ControlState' resources.", "x-one-of-name": "power.ControlState.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/power.ControlState.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "power.ControlState.Relationship": { "description": "A relationship to the 'power.ControlState' resource, or the expanded 'power.ControlState' resource, or the 'null' value.", "x-one-of-name": "power.ControlState.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/power.ControlState" } ], "discriminator": { "propertyName": "ClassId" } }, "power.ControlState": { "title": "Power:Control State", "description": "Managed object used to track chassis power capping information.", "x-allOf-name": "power.ControlState", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'power.ControlState', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "power.ControlState" ], "default": "power.ControlState", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "power.ControlState" ], "default": "power.ControlState", "x-enum-as-string": true }, "AllocatedPower": { "description": "This field identifies the allocated power on the chassis in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExtendedPowerCapacity": { "description": "The status of extended power capacity mode of the chassis. If Enabled, this mode allows chassis available power to be increased by borrowing power from redundant power supplies.\n* `Enabled` - Set the value to Enabled.\n* `Disabled` - Set the value to Disabled.\n* `Not Applicable` - Set the value to Not Applicable.", "type": "string", "enum": [ "Enabled", "Disabled", "Not Applicable" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "GridMaxPower": { "description": "This field identifies the available power when PSUs are in grid mode in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MaxRequiredPower": { "description": "This field identifies the maximum power required by the endpoint in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MinRequiredPower": { "description": "This field identifies the minimum power required by the endpoint in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "N1MaxPower": { "description": "This field identifies the available power when PSUs are in N+1 mode in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "N2MaxPower": { "description": "This field identifies the available power when PSUs are in N+2 mode in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NonRedundantMaxPower": { "description": "This field identifies the available power when PSUs are in non-redundant mode in Watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PowerRebalancing": { "description": "The status of power rebalancing mode of the chassis. If enabled, this mode allows the system to dynamically reallocate the power between servers depending on their power usage.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "PowerSaveMode": { "description": "The status of power save mode of the chassis. If Enabled and the requested power budget is less than available power\u00a0capacity, the additional PSUs not required to comply with redundancy policy are placed in Power Save mode.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "power.ControlState.List": { "title": "List of 'power.ControlState' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'power.ControlState' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'power.ControlState' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/power.ControlState" }, "nullable": true } } } ] }, "power.Policy.Response": { "description": "The response body of a HTTP GET request for the 'power.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'power.Policy' resources.", "x-one-of-name": "power.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/power.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "power.Policy": { "title": "Power", "description": "The Power Policy is a versatile, reusable policy for configuring power management features on both servers and chassis.\n#### Purpose\nThe purpose of this policy is to provide centralized control over power-related settings, allowing administrators to optimize for performance, power efficiency, or redundancy based on their specific needs. It standardizes settings like power redundancy for a chassis, power restore behavior for a server, and power allocation priorities for blades.\n#### Key Concepts\n- **Chassis and Server Application:** The policy contains settings applicable to both chassis (e.g., redundancyMode) and servers (e.g., powerRestoreState), and is applied via the corresponding profile type.\n- **Power Redundancy:** For chassis, it can define the redundancy mode (e.g., N+1, N+2, Grid), which determines how many Power Supply Units (PSUs) are kept in reserve.\n- **Power Restore State:** For servers, it dictates the power state (Always On, Always Off, or Last State) the server should return to after a power loss event.\n- **Power Allocation:** It can set a power budget for a chassis and define the power priority for individual servers, influencing how power is allocated in constrained environments.", "x-allOf-name": "power.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'power.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "power.Policy" ], "default": "power.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "power.Policy" ], "default": "power.Policy", "x-enum-as-string": true }, "AllocatedBudget": { "description": "Sets the limit for the maximum input power consumption by the chassis (in Watts). Set to 0 for no limit.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 65535, "x-omitempty": true }, "DynamicRebalancing": { "description": "Sets the dynamic power rebalancing mode of the chassis. If enabled, this mode allows the chassis to dynamically reallocate the power between servers depending on their power usage.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true }, "ExtendedPowerCapacity": { "description": "Sets the Extended Power Capacity of the Chassis. If Enabled, this mode allows chassis available power to be increased by borrowing power from redundant power supplies. This option is only supported for Cisco UCS X series Chassis.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true }, "PowerPriority": { "description": "Sets the Power Priority of the Server. This priority is used to determine the initial power allocation for servers. This field is only supported for Cisco UCS B series and X series servers.\n* `Low` - Set the Power Priority to Low.\n* `Medium` - Set the Power Priority to Medium.\n* `High` - Set the Power Priority to High.", "type": "string", "enum": [ "Low", "Medium", "High" ], "default": "Low", "x-omitempty": true }, "PowerProfiling": { "description": "Sets the Power Profiling of the Server. If Enabled, this field allows the power manager to run power profiling utility to determine the power needs of the server. This field is only supported for Cisco UCS X series servers.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true }, "PowerRestoreState": { "description": "Sets the Power Restore State of the Server. In the absence of Intersight connectivity, the chassis/server will use this policy to recover the host power after a power loss event.\n* `AlwaysOff` - Set the Power Restore Mode to Off.\n* `AlwaysOn` - Set the Power Restore Mode to On.\n* `LastState` - Set the Power Restore Mode to LastState.", "type": "string", "enum": [ "AlwaysOff", "AlwaysOn", "LastState" ], "default": "AlwaysOff", "x-omitempty": true }, "PowerSaveMode": { "description": "Sets the power save mode of the chassis. If the requested power budget is less than available power capacity, the additional PSUs not required to comply with redundancy policy are placed in power save mode.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true }, "ProcessorPackagePowerLimit": { "description": "Sets the Processor Package Power Limit (PPL) of a server. PPL refers to the amount of power that a CPU can draw from the power supply. The Processor Package Power Limit (PPL) feature is currently available exclusively on Cisco UCS C225/C245/C845 M8 servers.\n* `Default` - Set the Package Power Limit to the platform defined default value.\n* `Maximum` - Set the Package Power Limit to the platform defined maximum value.\n* `Minimum` - Set the Package Power Limit to the platform defined minimum value.", "type": "string", "enum": [ "Default", "Maximum", "Minimum" ], "default": "Default", "x-omitempty": true }, "RedundancyMode": { "description": "Sets the Power Redundancy Mode of the Chassis. Redundancy Mode determines the number of PSUs the chassis keeps as redundant. N+2 mode is only supported for Cisco UCS X series Chassis. Only Grid and NotRedundant modes are supported for Cisco Unified Edge Chassis.\n* `Grid` - Grid Mode requires two power sources. If one source fails, the surviving PSUs connected to the other source provides power to the chassis.\n* `NotRedundant` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements. No Redundant PSUs are maintained.\n* `N+1` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus one additional PSU for redundancy.\n* `N+2` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus two additional PSU for redundancy. This Mode is only supported for UCS X series Chassis.", "type": "string", "enum": [ "Grid", "NotRedundant", "N+1", "N+2" ], "default": "Grid", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "power.Policy.List": { "title": "List of 'power.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'power.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'power.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/power.Policy" }, "nullable": true } } } ] }, "power.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'power.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'power.PolicyInventory' resources.", "x-one-of-name": "power.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/power.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "power.PolicyInventory": { "title": "Power", "description": "The Power Policy is a versatile, reusable policy for configuring power management features on both servers and chassis.\n#### Purpose\nThe purpose of this policy is to provide centralized control over power-related settings, allowing administrators to optimize for performance, power efficiency, or redundancy based on their specific needs. It standardizes settings like power redundancy for a chassis, power restore behavior for a server, and power allocation priorities for blades.\n#### Key Concepts\n- **Chassis and Server Application:** The policy contains settings applicable to both chassis (e.g., redundancyMode) and servers (e.g., powerRestoreState), and is applied via the corresponding profile type.\n- **Power Redundancy:** For chassis, it can define the redundancy mode (e.g., N+1, N+2, Grid), which determines how many Power Supply Units (PSUs) are kept in reserve.\n- **Power Restore State:** For servers, it dictates the power state (Always On, Always Off, or Last State) the server should return to after a power loss event.\n- **Power Allocation:** It can set a power budget for a chassis and define the power priority for individual servers, influencing how power is allocated in constrained environments.", "x-allOf-name": "power.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'power.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "power.PolicyInventory" ], "default": "power.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "power.PolicyInventory" ], "default": "power.PolicyInventory", "x-enum-as-string": true }, "AllocatedBudget": { "description": "Sets the limit for the maximum input power consumption by the chassis (in Watts). Set to 0 for no limit.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "DynamicRebalancing": { "description": "Sets the dynamic power rebalancing mode of the chassis. If enabled, this mode allows the chassis to dynamically reallocate the power between servers depending on their power usage.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "ExtendedPowerCapacity": { "description": "Sets the Extended Power Capacity of the Chassis. If Enabled, this mode allows chassis available power to be increased by borrowing power from redundant power supplies. This option is only supported for Cisco UCS X series Chassis.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "PowerPriority": { "description": "Sets the Power Priority of the Server. This priority is used to determine the initial power allocation for servers. This field is only supported for Cisco UCS B series and X series servers.\n* `Low` - Set the Power Priority to Low.\n* `Medium` - Set the Power Priority to Medium.\n* `High` - Set the Power Priority to High.", "type": "string", "enum": [ "Low", "Medium", "High" ], "default": "Low", "readOnly": true, "x-omitempty": true }, "PowerProfiling": { "description": "Sets the Power Profiling of the Server. If Enabled, this field allows the power manager to run power profiling utility to determine the power needs of the server. This field is only supported for Cisco UCS X series servers.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "PowerRestoreState": { "description": "Sets the Power Restore State of the Server. In the absence of Intersight connectivity, the chassis/server will use this policy to recover the host power after a power loss event.\n* `AlwaysOff` - Set the Power Restore Mode to Off.\n* `AlwaysOn` - Set the Power Restore Mode to On.\n* `LastState` - Set the Power Restore Mode to LastState.", "type": "string", "enum": [ "AlwaysOff", "AlwaysOn", "LastState" ], "default": "AlwaysOff", "readOnly": true, "x-omitempty": true }, "PowerSaveMode": { "description": "Sets the power save mode of the chassis. If the requested power budget is less than available power capacity, the additional PSUs not required to comply with redundancy policy are placed in power save mode.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "readOnly": true, "x-omitempty": true }, "ProcessorPackagePowerLimit": { "description": "Sets the Processor Package Power Limit (PPL) of a server. PPL refers to the amount of power that a CPU can draw from the power supply. The Processor Package Power Limit (PPL) feature is currently available exclusively on Cisco UCS C225/C245/C845 M8 servers.\n* `Default` - Set the Package Power Limit to the platform defined default value.\n* `Maximum` - Set the Package Power Limit to the platform defined maximum value.\n* `Minimum` - Set the Package Power Limit to the platform defined minimum value.", "type": "string", "enum": [ "Default", "Maximum", "Minimum" ], "default": "Default", "readOnly": true, "x-omitempty": true }, "RedundancyMode": { "description": "Sets the Power Redundancy Mode of the Chassis. Redundancy Mode determines the number of PSUs the chassis keeps as redundant. N+2 mode is only supported for Cisco UCS X series Chassis. Only Grid and NotRedundant modes are supported for Cisco Unified Edge Chassis.\n* `Grid` - Grid Mode requires two power sources. If one source fails, the surviving PSUs connected to the other source provides power to the chassis.\n* `NotRedundant` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements. No Redundant PSUs are maintained.\n* `N+1` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus one additional PSU for redundancy.\n* `N+2` - Power Manager turns on the minimum number of PSUs required to support chassis power requirements plus two additional PSU for redundancy. This Mode is only supported for UCS X series Chassis.", "type": "string", "enum": [ "Grid", "NotRedundant", "N+1", "N+2" ], "default": "Grid", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "power.PolicyInventory.List": { "title": "List of 'power.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'power.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'power.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/power.PolicyInventory" }, "nullable": true } } } ] }, "power.PowerGroup.Response": { "description": "The response body of a HTTP GET request for the 'power.PowerGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'power.PowerGroup' resources.", "x-one-of-name": "power.PowerGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/power.PowerGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "power.PowerGroup.Relationship": { "description": "A relationship to the 'power.PowerGroup' resource, or the expanded 'power.PowerGroup' resource, or the 'null' value.", "x-one-of-name": "power.PowerGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/power.PowerGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "power.PowerGroup": { "title": "Power Group", "description": "A Power Group represents a collection of equipment that share the same power budget.", "x-allOf-name": "power.PowerGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'power.PowerGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "power.PowerGroup" ], "default": "power.PowerGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "power.PowerGroup" ], "default": "power.PowerGroup", "x-enum-as-string": true }, "AdminState": { "description": "Administrative state of the power group. Determines whether the power group is enabled or disabled.\n* `Enabled` - The power group is administratively enabled.\n* `Disabled` - The power group is administratively disabled.", "type": "string", "enum": [ "Enabled", "Disabled" ], "default": "Enabled", "x-omitempty": true }, "BufferPowerRequired": { "description": "Reserved power buffer calculated as 10% of total chassis minimum power requirements. FI and FEX do not contribute to buffer power.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "Power Group Configuration State.\n* `Ok` - The configuration state of the power group is ok. All members are configured successfully.\n* `Unknown` - The configuration state of the power group is not known.\n* `Configuring` - The power group is actively being configured. Transitional state during CREATE or UPDATE operations.\n* `PartiallyConfigured` - The power group configuration failed mid-way. Some members may be configured while others are not. Totals may not match actual membership. Reconciliation or manual intervention is required.\n* `PartiallyDeleted` - The configuration state of the power group is Partially Deleted. This occurs when a DELETE operation was initiated but the workflow to remove power limits did not succeed for all members.\n* `Disabling` - The power group is being disabled. A workflow is in progress to push 0 power limits to all member devices.\n* `PartiallyDisabled` - The power group disable operation failed mid-way. Some members may have their power limits removed while others retain their previous values. The power group remains in a disabled state but may require manual intervention.", "type": "string", "enum": [ "Ok", "Unknown", "Configuring", "PartiallyConfigured", "PartiallyDeleted", "Disabling", "PartiallyDisabled" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "Description": { "description": "Description of the power group.", "type": "string", "pattern": "^$|^[a-zA-Z0-9]+[\\x00-\\xFF]*$", "maxLength": 1024, "x-omitempty": true }, "Name": { "description": "User defined name for the power group.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "OperState": { "description": "Power Group Operational State.\n* `Ok` - The operational state of the power group is ok. All members are configured successfully.\n* `Unknown` - The operational state of the power group is not known.\n* `InsufficientPower` - The power group does not have sufficient power budget to meet the minimum power requirements of all its chassis members. This typically occurs when new hardware is added to a member chassis, increasing its minimum power requirement beyond the available budget.", "type": "string", "enum": [ "Ok", "Unknown", "InsufficientPower" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "PowerBudget": { "description": "Maximum power budget allocated to this power group in watts.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 1000000, "x-omitempty": true }, "TotalMaximumPowerRequired": { "description": "Sum of maximum power required for each member in this group in watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalMinimumPowerRequired": { "description": "Sum of minimum power required for each member in this group in watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceMember": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true }, "PowerGroupMember": { "description": "An array of relationships to powerPowerGroupMember resources.", "type": "array", "items": { "$ref": "#/components/schemas/power.PowerGroupMember.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "power.PowerGroup.List": { "title": "List of 'power.PowerGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'power.PowerGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'power.PowerGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/power.PowerGroup" }, "nullable": true } } } ] }, "power.PowerGroupMember.Response": { "description": "The response body of a HTTP GET request for the 'power.PowerGroupMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'power.PowerGroupMember' resources.", "x-one-of-name": "power.PowerGroupMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/power.PowerGroupMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "power.PowerGroupMember.Relationship": { "description": "A relationship to the 'power.PowerGroupMember' resource, or the expanded 'power.PowerGroupMember' resource, or the 'null' value.", "x-one-of-name": "power.PowerGroupMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/power.PowerGroupMember" } ], "discriminator": { "propertyName": "ClassId" } }, "power.PowerGroupMember": { "title": "Power:Power Group Member", "description": "Managed object used to track power information for a member of a power group.", "x-allOf-name": "power.PowerGroupMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'power.PowerGroupMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "power.PowerGroupMember" ], "default": "power.PowerGroupMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "power.PowerGroupMember" ], "default": "power.PowerGroupMember", "x-enum-as-string": true }, "AllocatedPower": { "description": "Power allocated to the power group member by the power group in watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "Configuration State of the power group member.\n* `Ok` - The configuration state of the power group member is ok.\n* `Unknown` - The configuration state of the power group member is not known.\n* `PendingRemoval` - The power group member is pending removal. The member has been removed from the power group's InventoryDeviceMember list but the workflow to remove power limit from the device has not yet completed. Once the workflow succeeds, this member MO will be deleted.", "type": "string", "enum": [ "Ok", "Unknown", "PendingRemoval" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "DeviceRegistrationMoid": { "description": "Moid of the asset.DeviceRegistration corresponding to this member's inventory device.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaxRequiredPower": { "description": "Maximum power required by the power group member in watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "MemberType": { "description": "The type of the power group member - Chassis, Fex or Fabric Interconnect.\n* `Unknown` - The power group member type is unknown.\n* `Chassis` - The power group member is a chassis.\n* `Fex` - The power group member is a Fex.\n* `FabricInterconnect` - The power group member is a Fabric Interconnect.", "type": "string", "enum": [ "Unknown", "Chassis", "Fex", "FabricInterconnect" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "MinRequiredPower": { "description": "Minimum power required by the power group member in watts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "Operational State of the power group member.\n* `Ok` - The operational state of the power group member is ok.\n* `PowerConsumptionNearingLimit` - Operational state for power group member is PowerConsumptionNearingLimit. This may happen when the current power consumption of a chassis approaches the chassis power limit.", "type": "string", "enum": [ "Ok", "PowerConsumptionNearingLimit" ], "default": "Ok", "readOnly": true, "x-omitempty": true }, "InventoryDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PowerGroupParent": { "$ref": "#/components/schemas/power.PowerGroup.Relationship", "description": "A reference to a powerPowerGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "power.PowerGroupMember.List": { "title": "List of 'power.PowerGroupMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'power.PowerGroupMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'power.PowerGroupMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/power.PowerGroupMember" }, "nullable": true } } } ] }, "processor.Unit.Response": { "description": "The response body of a HTTP GET request for the 'processor.Unit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'processor.Unit' resources.", "x-one-of-name": "processor.Unit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/processor.Unit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "processor.Unit.Relationship": { "description": "A relationship to the 'processor.Unit' resource, or the expanded 'processor.Unit' resource, or the 'null' value.", "x-one-of-name": "processor.Unit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/processor.Unit" } ], "discriminator": { "propertyName": "ClassId" } }, "processor.Unit": { "title": "Processor:Unit", "description": "The CPU present on a server.", "x-allOf-name": "processor.Unit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'processor.Unit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "processor.Unit" ], "default": "processor.Unit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "processor.Unit" ], "default": "processor.Unit", "x-enum-as-string": true }, "Architecture": { "description": "The architecture of the installed processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field displays the description of the processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsPlatformSupported": { "description": "This field indicates whether the processor is supported on the server or not.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "NumCores": { "description": "The number of cores present in a given processor.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumCoresEnabled": { "description": "The number of enabled cores in the installed processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumThreads": { "description": "The maximum number of threads available in the installed processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "The power state of the processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the processor.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The health indicator of the processor, 'OK' indicates the processor is operatinal.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability state of the central processing unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "This field displays the part number of the of the processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field displays the product ID of the processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProcessorId": { "description": "The ID number of a given processor.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SocketDesignation": { "description": "The socket ID of the installed processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Speed": { "description": "The maximum speed of the installed processor in GHz.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Stepping": { "description": "The CPU stepping of the installed processor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "The temperature of the processor in centigrade.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ConnectedPcieDevices": { "description": "An array of relationships to moBaseMo resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PciEndpoint": { "$ref": "#/components/schemas/pci.Endpoint.Relationship", "description": "A reference to a pciEndpoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "processor.Unit.List": { "title": "List of 'processor.Unit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'processor.Unit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'processor.Unit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/processor.Unit" }, "nullable": true } } } ] }, "rack.UnitPersonality.Response": { "description": "The response body of a HTTP GET request for the 'rack.UnitPersonality' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'rack.UnitPersonality' resources.", "x-one-of-name": "rack.UnitPersonality.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/rack.UnitPersonality.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "rack.UnitPersonality.Relationship": { "description": "A relationship to the 'rack.UnitPersonality' resource, or the expanded 'rack.UnitPersonality' resource, or the 'null' value.", "x-one-of-name": "rack.UnitPersonality.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/rack.UnitPersonality" } ], "discriminator": { "propertyName": "ClassId" } }, "rack.UnitPersonality": { "title": "RackUnit Personality", "description": "This can be used internally to model a server based on a defined personality without having to reprogram the server PID.", "x-allOf-name": "rack.UnitPersonality", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'rack.UnitPersonality', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "rack.UnitPersonality" ], "default": "rack.UnitPersonality", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "rack.UnitPersonality" ], "default": "rack.UnitPersonality", "x-enum-as-string": true }, "AdditionalInfo": { "description": "Additional info about the added software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the software personality.", "type": "string", "readOnly": true, "x-omitempty": true }, "PersonalityId": { "description": "Unique identity of added software personality.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "rack.UnitPersonality.List": { "title": "List of 'rack.UnitPersonality' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'rack.UnitPersonality' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'rack.UnitPersonality' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/rack.UnitPersonality" }, "nullable": true } } } ] }, "sdcard.Diagnostics": { "title": "Diagnostics", "description": "This partition is used for diagnostics utility. This drive is available under utility partition.", "x-allOf-name": "sdcard.Diagnostics", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" } ] }, "sdcard.Drivers": { "title": "Drivers", "description": "This partition is used for drivers. This drive is available under utility partition.", "x-allOf-name": "sdcard.Drivers", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" } ] }, "sdcard.HostUpgradeUtility": { "title": "Host Upgrade Utility", "description": "This partition is used for host upgrade utility referred as HUU. This drive is available under utility partition.", "x-allOf-name": "sdcard.HostUpgradeUtility", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" } ] }, "sdcard.OperatingSystem": { "title": "Operating System", "description": "This partition is used for OS install and is commonly known as Hypervisor partition. This drive is available under OS partition.", "x-allOf-name": "sdcard.OperatingSystem", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.OperatingSystem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdcard.OperatingSystem" ], "default": "sdcard.OperatingSystem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdcard.OperatingSystem" ], "default": "sdcard.OperatingSystem", "x-enum-as-string": true }, "Name": { "description": "Name of virtual drive for operating system partition.", "type": "string", "default": "Hypervisor", "maxLength": 15, "x-omitempty": true } } } ] }, "sdcard.Partition": { "title": "Sdcard:Partition", "description": "This adds and configures operating system partitions.", "x-allOf-name": "sdcard.Partition", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.Partition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdcard.Partition" ], "default": "sdcard.Partition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdcard.Partition" ], "default": "sdcard.Partition", "x-enum-as-string": true }, "Type": { "description": "This specifies the type of the partition. Allowed values are OS, Utility.\n* `OS` - This partition contains virtual drives where user can install operating system.\n* `Utility` - This partition contains virtual drives for utilities such as SCU, HUU, Drivers and Diagnostics.", "type": "string", "enum": [ "OS", "Utility" ], "default": "OS", "x-omitempty": true }, "VirtualDrives": { "type": "array", "items": { "description": "Collection of available virtual drives.", "$ref": "#/components/schemas/sdcard.VirtualDrive", "x-omitempty": true }, "nullable": true } } } ] }, "sdcard.Policy.Response": { "description": "The response body of a HTTP GET request for the 'sdcard.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sdcard.Policy' resources.", "x-one-of-name": "sdcard.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sdcard.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sdcard.Policy": { "title": "SD Card", "description": "The Policy object is a framework for configuring SD Card settings on endpoints, with a focus on managing partition types and virtual drives.\n#### Purpose\nThe Policy object simplifies the configuration and deployment of SD Card settings. It enables partition management by defining partition types and associated virtual drives, and facilitates drive configuration within these partitions, enhancing overall endpoint resource management.\n#### Key Concepts\n- **Virtual Drives:** Supports the creation and management of virtual drives within OS and utility partitions.\n- **Inventory Integration:** Generates inventory objects to track and manage SD Card settings across endpoints.\n- **Deprecated Relationships:** While maintaining backward compatibility, certain relationship settings are marked deprecated.", "x-allOf-name": "sdcard.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdcard.Policy" ], "default": "sdcard.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdcard.Policy" ], "default": "sdcard.Policy", "x-enum-as-string": true }, "Partitions": { "type": "array", "items": { "description": "Collection of configured partitions.", "$ref": "#/components/schemas/sdcard.Partition", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "sdcard.Policy.List": { "title": "List of 'sdcard.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sdcard.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sdcard.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sdcard.Policy" }, "nullable": true } } } ] }, "sdcard.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'sdcard.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sdcard.PolicyInventory' resources.", "x-one-of-name": "sdcard.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sdcard.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sdcard.PolicyInventory": { "title": "SD Card", "description": "The Policy object is a framework for configuring SD Card settings on endpoints, with a focus on managing partition types and virtual drives.\n#### Purpose\nThe Policy object simplifies the configuration and deployment of SD Card settings. It enables partition management by defining partition types and associated virtual drives, and facilitates drive configuration within these partitions, enhancing overall endpoint resource management.\n#### Key Concepts\n- **Virtual Drives:** Supports the creation and management of virtual drives within OS and utility partitions.\n- **Inventory Integration:** Generates inventory objects to track and manage SD Card settings across endpoints.\n- **Deprecated Relationships:** While maintaining backward compatibility, certain relationship settings are marked deprecated.", "x-allOf-name": "sdcard.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdcard.PolicyInventory" ], "default": "sdcard.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdcard.PolicyInventory" ], "default": "sdcard.PolicyInventory", "x-enum-as-string": true }, "Partitions": { "type": "array", "items": { "description": "Collection of configured partitions.", "$ref": "#/components/schemas/sdcard.Partition", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "sdcard.PolicyInventory.List": { "title": "List of 'sdcard.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sdcard.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sdcard.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sdcard.PolicyInventory" }, "nullable": true } } } ] }, "sdcard.ServerConfigurationUtility": { "title": "Server Configuration Utility", "description": "This partition is used for server configuration utility referred as SCU. This drive is available under utility partition.", "x-allOf-name": "sdcard.ServerConfigurationUtility", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" } ] }, "sdcard.UserPartition": { "title": "User Partition", "description": "This partition is available for user to use. This drive is available under utility partition.", "x-allOf-name": "sdcard.UserPartition", "allOf": [ { "$ref": "#/components/schemas/sdcard.VirtualDrive" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.UserPartition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sdcard.UserPartition" ], "default": "sdcard.UserPartition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sdcard.UserPartition" ], "default": "sdcard.UserPartition", "x-enum-as-string": true }, "Name": { "description": "Name of virtual drive for user partition.", "type": "string", "default": "UserPartition", "maxLength": 15, "x-omitempty": true } } } ] }, "sdcard.VirtualDrive": { "title": "Sdcard:Virtual Drive", "description": "Base type for the virtual drive.", "x-allOf-name": "sdcard.VirtualDrive", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'sdcard.VirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "sdcard.Diagnostics", "sdcard.Drivers", "sdcard.HostUpgradeUtility", "sdcard.OperatingSystem", "sdcard.ServerConfigurationUtility", "sdcard.UserPartition" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "sdcard.Diagnostics", "sdcard.Drivers", "sdcard.HostUpgradeUtility", "sdcard.OperatingSystem", "sdcard.ServerConfigurationUtility", "sdcard.UserPartition" ], "x-enum-as-string": true }, "Enable": { "description": "Enable the respective virtual drive to be available to the host.", "type": "boolean", "x-omitempty": true } } } ] }, "security.Unit.Response": { "description": "The response body of a HTTP GET request for the 'security.Unit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'security.Unit' resources.", "x-one-of-name": "security.Unit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/security.Unit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "security.Unit.Relationship": { "description": "A relationship to the 'security.Unit' resource, or the expanded 'security.Unit' resource, or the 'null' value.", "x-one-of-name": "security.Unit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/security.Unit" } ], "discriminator": { "propertyName": "ClassId" } }, "security.Unit": { "title": "Security:Unit", "description": "The crypto card present on a server.", "x-allOf-name": "security.Unit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'security.Unit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "security.Unit" ], "default": "security.Unit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "security.Unit" ], "default": "security.Unit", "x-enum-as-string": true }, "OperState": { "description": "Operational state of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability state of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "The part number of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "PCIe slot of the security unit in the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Power": { "description": "Power state of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "Thermal state of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "UnitId": { "description": "The unique identifier assigned to the security unit within the server.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Vid": { "description": "The vendor identifier of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "Voltage": { "description": "The voltage state of the security unit.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "security.Unit.List": { "title": "List of 'security.Unit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'security.Unit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'security.Unit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/security.Unit" }, "nullable": true } } } ] }, "server.BaseProfile.Relationship": { "description": "A relationship to the 'server.BaseProfile' resource, or the expanded 'server.BaseProfile' resource, or the 'null' value.", "x-one-of-name": "server.BaseProfile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.BaseProfile" } ], "discriminator": { "propertyName": "ClassId" } }, "server.BaseProfile": { "title": "Server Profile", "description": "A profile specifying configuration settings for a physical server.", "x-allOf-name": "server.BaseProfile", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.BaseProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "server.Profile", "server.ProfileTemplate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "server.Profile", "server.ProfileTemplate" ], "x-enum-as-string": true }, "ManagementMode": { "description": "The management mode of the server.\n* `IntersightStandalone` - Intersight Standalone mode of operation.\n* `Intersight` - Intersight managed mode of operation.", "type": "string", "enum": [ "IntersightStandalone", "Intersight" ], "default": "IntersightStandalone", "readOnly": true, "x-omitempty": true }, "ServerFamily": { "description": "The server family type applicable to a server profile when the target platform is Standalone. For all other platform types, the value should be All.\n* `Unspecified` - Server Family type for Unspecified servers.\n* `All` - All server family types are included under this category.\n* `UCSC845A` - Server Family type for UCS C845A servers.\n* `UCSC2XX/4XX` - Server Family type for UCS C2XX/4XX servers.", "type": "string", "enum": [ "Unspecified", "All", "UCSC845A", "UCSC2XX/4XX" ], "default": "Unspecified", "x-createOnly": true, "x-omitempty": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "x-omitempty": true }, "UuidAddressType": { "description": "UUID address allocation type selected to assign an UUID address for the server.\n* `NONE` - The user did not assign any UUID address.\n* `STATIC` - The user assigns a static UUID address.\n* `POOL` - The user selects a pool from which the address will be leased.", "type": "string", "enum": [ "NONE", "STATIC", "POOL" ], "default": "NONE", "x-omitempty": true }, "ConfigResult": { "$ref": "#/components/schemas/server.ConfigResult.Relationship", "description": "A reference to a serverConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "UuidPool": { "$ref": "#/components/schemas/uuidpool.Pool.Relationship", "description": "A reference to a uuidpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "server.ConfigChangeDetail.Response": { "description": "The response body of a HTTP GET request for the 'server.ConfigChangeDetail' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ConfigChangeDetail' resources.", "x-one-of-name": "server.ConfigChangeDetail.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ConfigChangeDetail.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ConfigChangeDetail.Relationship": { "description": "A relationship to the 'server.ConfigChangeDetail' resource, or the expanded 'server.ConfigChangeDetail' resource, or the 'null' value.", "x-one-of-name": "server.ConfigChangeDetail.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.ConfigChangeDetail" } ], "discriminator": { "propertyName": "ClassId" } }, "server.ConfigChangeDetail": { "title": "Server:Config Change Detail", "description": "The configuration change details are captured here.", "x-allOf-name": "server.ConfigChangeDetail", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigChangeDetail" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ConfigChangeDetail', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ConfigChangeDetail" ], "default": "server.ConfigChangeDetail", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ConfigChangeDetail" ], "default": "server.ConfigChangeDetail", "x-enum-as-string": true }, "Profile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "server.ConfigChangeDetail.List": { "title": "List of 'server.ConfigChangeDetail' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ConfigChangeDetail' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ConfigChangeDetail' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigChangeDetail" }, "nullable": true } } } ] }, "server.ConfigImport.Response": { "description": "The response body of a HTTP GET request for the 'server.ConfigImport' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ConfigImport' resources.", "x-one-of-name": "server.ConfigImport.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ConfigImport.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ConfigImport": { "title": "Server:Config Import", "description": "Configuration import action will import the existing configuration from physical server and generate Intersight policies and server profile from it. At end of successful import, server will be assigned to the generated profile which has policies associated with it. No server profile or policies will be generated if configuration import fails.", "x-allOf-name": "server.ConfigImport", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ConfigImport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ConfigImport" ], "default": "server.ConfigImport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ConfigImport" ], "default": "server.ConfigImport", "x-enum-as-string": true }, "Description": { "description": "Description of the imported profile.", "type": "string", "x-omitempty": true }, "PolicyPrefix": { "description": "Policy prefix for the policies of the imported server profile.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,32}$", "x-omitempty": true }, "PolicyTypes": { "type": "array", "items": { "description": "Types of the policies to be imported for the imported server profile.", "type": "string", "x-omitempty": true }, "nullable": true }, "ProfileName": { "description": "Profile name for the imported server profile.", "type": "string", "pattern": "^[a-zA-Z0-9_.-]{1,64}$", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Server": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ServerProfile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "server.ConfigImport.List": { "title": "List of 'server.ConfigImport' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ConfigImport' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ConfigImport' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigImport" }, "nullable": true } } } ] }, "server.ConfigResult.Response": { "description": "The response body of a HTTP GET request for the 'server.ConfigResult' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ConfigResult' resources.", "x-one-of-name": "server.ConfigResult.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ConfigResult.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ConfigResult.Relationship": { "description": "A relationship to the 'server.ConfigResult' resource, or the expanded 'server.ConfigResult' resource, or the 'null' value.", "x-one-of-name": "server.ConfigResult.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.ConfigResult" } ], "discriminator": { "propertyName": "ClassId" } }, "server.ConfigResult": { "title": "Server:Config Result", "description": "The ConfigResult object plays a vital role in server profile management by providing detailed insights into the configuration process. This captures the results of configuration actions, including deployments and validations, offering transparency and accountability in configuration management. \n#### Purpose \nConfigResult is essential for tracking the outcomes of server profile configuration actions, ensuring that deployments and validations are accurately reported and issues are promptly identified. \n#### Key Concepts \n- **Result Tracking:** Captures detailed information about configuration results, including errors, warnings, and successful actions. \n- **Validation and Deployment:** Provides insights into the validation and deployment stages, supporting troubleshooting and optimization of server configurations.\n- **Relationship Management:** Linked with other objects to offer comprehensive views of configuration impacts. \n- **Read-Only Access:** Primarily designed for consumption, ensuring safe integration with systems requiring configuration insights.", "x-allOf-name": "server.ConfigResult", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigResult" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ConfigResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ConfigResult" ], "default": "server.ConfigResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ConfigResult" ], "default": "server.ConfigResult", "x-enum-as-string": true }, "Profile": { "$ref": "#/components/schemas/server.BaseProfile.Relationship", "description": "A reference to a serverBaseProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ResultEntries": { "description": "An array of relationships to serverConfigResultEntry resources.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigResultEntry.Relationship" }, "nullable": true } } } ] }, "server.ConfigResult.List": { "title": "List of 'server.ConfigResult' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ConfigResult' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ConfigResult' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigResult" }, "nullable": true } } } ] }, "server.ConfigResultEntry.Response": { "description": "The response body of a HTTP GET request for the 'server.ConfigResultEntry' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ConfigResultEntry' resources.", "x-one-of-name": "server.ConfigResultEntry.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ConfigResultEntry.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ConfigResultEntry.Relationship": { "description": "A relationship to the 'server.ConfigResultEntry' resource, or the expanded 'server.ConfigResultEntry' resource, or the 'null' value.", "x-one-of-name": "server.ConfigResultEntry.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.ConfigResultEntry" } ], "discriminator": { "propertyName": "ClassId" } }, "server.ConfigResultEntry": { "title": "Server:Config Result Entry", "description": "The ConfigResultEntry object for server profiles provides detailed information about each step or result in the configuration process.\n#### Purpose\nChassis ConfigResultEntry enables precise tracking and diagnosis of configuration steps, supporting troubleshooting and operational assurance.\n#### Key Concepts\n- **Granular Reporting:** Captures individual messages and outcomes for each configuration step.\n- **Contextual Insight:** Linked to overall ConfigResult for comprehensive status tracking.\n- **Operational Transparency:** Facilitates clear communication of configuration progress and issues.", "x-allOf-name": "server.ConfigResultEntry", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigResultEntry" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ConfigResultEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ConfigResultEntry" ], "default": "server.ConfigResultEntry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ConfigResultEntry" ], "default": "server.ConfigResultEntry", "x-enum-as-string": true }, "ConfigResult": { "$ref": "#/components/schemas/server.ConfigResult.Relationship", "description": "A reference to a serverConfigResult resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "server.ConfigResultEntry.List": { "title": "List of 'server.ConfigResultEntry' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ConfigResultEntry' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ConfigResultEntry' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigResultEntry" }, "nullable": true } } } ] }, "server.DiagnosticResult": { "title": "Server:Diagnostic Result", "description": "The result of the diagnostics being run.", "x-allOf-name": "server.DiagnosticResult", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.DiagnosticResult', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.DiagnosticResult" ], "default": "server.DiagnosticResult", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.DiagnosticResult" ], "default": "server.DiagnosticResult", "x-enum-as-string": true }, "MainComponent": { "description": "It represents the main component on which diagnostics were performed. It could be a \nphysical component such as CPU. When the main component is specified in the request, the response \nwill include test reports for subcomponents like CPU1 and CPU2, it should be classified under \na main component like CPU.\n* `CPU` - This represents the CPU component.\n* `Memory` - This represents the Memory component.\n* `Storage` - This represents the Storage component.\n* `Network` - This represents the Network component.\n* `Graphics` - This represents the Graphics component.\n* `NVME` - This represents the NVME component.\n* `BMC` - This represents the BMC component.", "type": "string", "enum": [ "CPU", "Memory", "Storage", "Network", "Graphics", "NVME", "BMC" ], "default": "CPU", "readOnly": true, "x-omitempty": true }, "Message": { "description": "The message received from the endpoint on completion of the diagnostics. It contains the error message in case the diagnostics failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Resolution": { "description": "Resolution in case the diagnostics failed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the diagnostics test performed on the component.\n* `OK` - The diagnostics severity is successful.\n* `Warning` - The diagnostics severity is warning.\n* `Critical` - The diagnostics severity is critical.", "type": "string", "enum": [ "OK", "Warning", "Critical" ], "default": "OK", "readOnly": true, "x-omitempty": true }, "SubComponentName": { "description": "It represents the sub component name on which diagnostics were performed. It could be a \nphysical component such as CPU1 or CPU2. When the main component, like the CPU, is specified in the \ndiagnostics request to the endpoint, the response will include test reports for subcomponents \nlike CPU1 and CPU2.", "type": "string", "readOnly": true, "x-omitempty": true }, "SubComponentProgress": { "description": "Progress of the diagnostics test run on the sub component.\n* `New` - The diagnostic task state representing new state.\n* `Running` - The diagnostic task state representing running state.\n* `Exception` - The diagnostic task state representing exception state.\n* `Completed` - The diagnostic task state representing completed state.", "type": "string", "enum": [ "New", "Running", "Exception", "Completed" ], "default": "New", "readOnly": true, "x-omitempty": true } } } ] }, "server.DiagnosticStatus.Response": { "description": "The response body of a HTTP GET request for the 'server.DiagnosticStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.DiagnosticStatus' resources.", "x-one-of-name": "server.DiagnosticStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.DiagnosticStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.DiagnosticStatus.Relationship": { "description": "A relationship to the 'server.DiagnosticStatus' resource, or the expanded 'server.DiagnosticStatus' resource, or the 'null' value.", "x-one-of-name": "server.DiagnosticStatus.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.DiagnosticStatus" } ], "discriminator": { "propertyName": "ClassId" } }, "server.DiagnosticStatus": { "title": "Server Diagnostics Status", "description": "Diagnostics status report of the health check run on the server hardware components.", "x-allOf-name": "server.DiagnosticStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/connector.DownloadStatus" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.DiagnosticStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.DiagnosticStatus" ], "default": "server.DiagnosticStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.DiagnosticStatus" ], "default": "server.DiagnosticStatus", "x-enum-as-string": true }, "DiagnosticsType": { "description": "Type of diagnostics to be performed on the server hardware components.\n* `Quick` - Perform fast and limited diagnostics on server hardware components.\n* `Comprehensive` - Perform slow and extensive diagnostics on server hardware components.", "type": "string", "enum": [ "Quick", "Comprehensive" ], "default": "Quick", "x-omitempty": true }, "DownloadMessage": { "description": "The message from the endpoint during the download.", "type": "string", "readOnly": true, "x-omitempty": true }, "DownloadPercentage": { "description": "The percentage of the image downloaded in the endpoint.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DownloadStage": { "description": "The image download stages. Example:downloading, flashing.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the diagnostics being run.", "type": "string", "readOnly": true, "x-omitempty": true }, "OverallState": { "description": "The overall state of the diagnostics being run.\n* `Queued` - The diagnostics are queued.\n* `InProgress` - The diagnostics are in progress.\n* `Completed` - The diagnostics are completed.\n* `Failed` - The diagnostics have failed.\n* `Terminated` - The diagnostics are terminated.", "type": "string", "enum": [ "Queued", "InProgress", "Completed", "Failed", "Terminated" ], "default": "Queued", "readOnly": true, "x-omitempty": true }, "Progress": { "description": "The progress of the diagnostics being run.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Result": { "type": "array", "items": { "description": "The result of the diagnostics being run.", "$ref": "#/components/schemas/server.DiagnosticResult", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SdCardDownloadError": { "description": "The error message from the endpoint during the SD card download.", "type": "string", "readOnly": true, "x-omitempty": true }, "Diagnostics": { "$ref": "#/components/schemas/server.Diagnostics.Relationship", "description": "A reference to a serverDiagnostics resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Workflow": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship", "description": "A reference to a workflowWorkflowInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "server.DiagnosticStatus.List": { "title": "List of 'server.DiagnosticStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.DiagnosticStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.DiagnosticStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.DiagnosticStatus" }, "nullable": true } } } ] }, "server.Diagnostics.Response": { "description": "The response body of a HTTP GET request for the 'server.Diagnostics' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.Diagnostics' resources.", "x-one-of-name": "server.Diagnostics.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.Diagnostics.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.Diagnostics.Relationship": { "description": "A relationship to the 'server.Diagnostics' resource, or the expanded 'server.Diagnostics' resource, or the 'null' value.", "x-one-of-name": "server.Diagnostics.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.Diagnostics" } ], "discriminator": { "propertyName": "ClassId" } }, "server.Diagnostics": { "title": "Perform Server Diagnostics", "description": "The Diagnostics object is designed to facilitate health checks on server hardware components. It plays a crucial role in ensuring the operational integrity and performance of server infrastructure by performing diagnostics on various hardware elements.\n#### Purpose\nThe Diagnostics object is intended to conduct quick and comprehensive evaluations of server hardware, identifying potential issues and ensuring that components function as expected. This provides a structured approach to initiating, managing, and reporting on diagnostic tests for server components.\n#### Key Concepts\n- **Comprehensive Testing:** Supports a wide range of diagnostic tests, covering multiple hardware components such as CPU, memory, storage, and more.\n- **Action Management:** Facilitates the start, cancellation, and completion of diagnostic processes, allowing for flexible management of diagnostic operations.\n- **Access Control:** Employs privilege sets to manage who can initiate and manage diagnostics, ensuring that only authorized users perform these operations.", "x-allOf-name": "server.Diagnostics", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.Diagnostics', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.Diagnostics" ], "default": "server.Diagnostics", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.Diagnostics" ], "default": "server.Diagnostics", "x-enum-as-string": true }, "Action": { "description": "The action to be performed on the server whether to start or to cancel the diagnostics.\n* `Start` - Mark the start of the diagnostics on the server.\n* `Cancel` - Mark the cancellation of the diagnostics on the server.\n* `Complete` - Mark the completion of the diagnostics on the server.", "type": "string", "enum": [ "Start", "Cancel", "Complete" ], "default": "Start", "x-omitempty": true }, "ComponentList": { "type": "array", "items": { "description": "List of components on which diagnostics will be performed.\n* `CPU` - This represents the CPU component.\n* `Memory` - This represents the Memory component.\n* `Storage` - This represents the Storage component.\n* `Network` - This represents the Network component.\n* `Graphics` - This represents the Graphics component.\n* `NVME` - This represents the NVME component.\n* `BMC` - This represents the BMC component.", "type": "string", "enum": [ "CPU", "Memory", "Storage", "Network", "Graphics", "NVME", "BMC" ], "default": "CPU", "x-omitempty": true }, "nullable": true }, "DiagnosticsType": { "description": "Type of diagnostics to be performed on the server hardware components.\n* `Quick` - Perform fast and limited diagnostics on server hardware components.\n* `Comprehensive` - Perform slow and extensive diagnostics on server hardware components.", "type": "string", "enum": [ "Quick", "Comprehensive" ], "default": "Quick", "x-omitempty": true }, "Name": { "description": "The name of the diagnostics being run.", "type": "string", "x-omitempty": true }, "DiagnosticStatus": { "$ref": "#/components/schemas/server.DiagnosticStatus.Relationship", "description": "A reference to a serverDiagnosticStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "server.Diagnostics.List": { "title": "List of 'server.Diagnostics' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.Diagnostics' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.Diagnostics' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.Diagnostics" }, "nullable": true } } } ] }, "server.Disruption.Response": { "description": "The response body of a HTTP GET request for the 'server.Disruption' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.Disruption' resources.", "x-one-of-name": "server.Disruption.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.Disruption.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.Disruption": { "title": "Server:Disruption", "description": "The Disruption object documents disruption events related to server profiles. This provides details on interruptions or issues that may impact server operation or configuration.\n#### Purpose\nDisruption is designed to inform administrators and systems of disruptions, supporting incident response and root cause analysis.\n#### Key Concepts\n- **Event Documentation:** Captures details about disruptions for subsequent review and action.\n- **Operational Awareness:** Integrates with monitoring and alerting systems to provide timely information on disruptions.\n- **Audit Trail:** Maintains a record of all disruptions affecting server profiles.", "x-allOf-name": "server.Disruption", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractDisruption" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.Disruption', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.Disruption" ], "default": "server.Disruption", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.Disruption" ], "default": "server.Disruption", "x-enum-as-string": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "server.Disruption.List": { "title": "List of 'server.Disruption' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.Disruption' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.Disruption' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.Disruption" }, "nullable": true } } } ] }, "server.MigrationKeyDetails.Response": { "description": "The response body of a HTTP GET request for the 'server.MigrationKeyDetails' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.MigrationKeyDetails' resources.", "x-one-of-name": "server.MigrationKeyDetails.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.MigrationKeyDetails.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.MigrationKeyDetails.Relationship": { "description": "A relationship to the 'server.MigrationKeyDetails' resource, or the expanded 'server.MigrationKeyDetails' resource, or the 'null' value.", "x-one-of-name": "server.MigrationKeyDetails.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.MigrationKeyDetails" } ], "discriminator": { "propertyName": "ClassId" } }, "server.MigrationKeyDetails": { "title": "Server:Migration Key Details", "description": "The ServerMigrationDetails object holds the migration key information for servers that are being migrated from one Server profile to another.", "x-allOf-name": "server.MigrationKeyDetails", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.MigrationKeyDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.MigrationKeyDetails" ], "default": "server.MigrationKeyDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.MigrationKeyDetails" ], "default": "server.MigrationKeyDetails", "x-enum-as-string": true }, "MigrationKeyInfo": { "description": "The migration key info used for migrating the server profile.", "$ref": "#/components/schemas/compute.MigrationKeyInfo", "readOnly": true, "x-omitempty": true }, "DownloadStatus": { "$ref": "#/components/schemas/compute.DownloadStatus.Relationship", "description": "A reference to a computeDownloadStatus resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Server": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "server.MigrationKeyDetails.List": { "title": "List of 'server.MigrationKeyDetails' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.MigrationKeyDetails' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.MigrationKeyDetails' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.MigrationKeyDetails" }, "nullable": true } } } ] }, "server.PendingWorkflowTrigger": { "title": "Server:Pending Workflow Trigger", "description": "A workflow trigger that is waiting for a response from the workflow engine.", "x-allOf-name": "server.PendingWorkflowTrigger", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "server.Profile.Response": { "description": "The response body of a HTTP GET request for the 'server.Profile' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.Profile' resources.", "x-one-of-name": "server.Profile.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.Profile.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.Profile.Relationship": { "description": "A relationship to the 'server.Profile' resource, or the expanded 'server.Profile' resource, or the 'null' value.", "x-one-of-name": "server.Profile.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/server.Profile" } ], "discriminator": { "propertyName": "ClassId" } }, "server.Profile": { "title": "Server Profile", "description": "The Profile object represents a server profile, specifying configuration settings for a physical server. It encapsulates all necessary information to deploy, manage, and monitor a server within the infrastructure.\n#### Purpose\nA Profile is used to apply detailed configuration and policy settings to an individual server, supporting lifecycle management, compliance, and automation.\n#### Key Concepts\n- **Configuration Management:** Centralizes all relevant configuration states, changes, and compliance results for the server.\n- **Policy Attachment:** Associates various policies and pools (such as UUID pools and resource pools) to define operational parameters.\n- **Assignment and Deployment:** Supports both static and dynamic assignment of physical servers, as well as monitoring deployment status and results.\n- **Lifecycle Tracking:** Integrates with workflow engines and maintains audit trails for configuration changes and applied policies.", "x-allOf-name": "server.Profile", "allOf": [ { "$ref": "#/components/schemas/server.BaseProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.Profile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.Profile" ], "default": "server.Profile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.Profile" ], "default": "server.Profile", "x-enum-as-string": true }, "ConfigChangeContext": { "description": "The configuration change state and results of the last change operation.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.ConfigChangeContext", "readOnly": true, "x-omitempty": true }, "ConfigChanges": { "description": "Pending configuration changes at the summary level. Detail changes are saved in configChangeDetails as a separate object.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.ConfigChange", "readOnly": true, "x-omitempty": true }, "DeployStatus": { "description": "The status of the server profile indicating if deployment has been initiated on both fabric interconnects or not.\n* `None` - Switch profiles not deployed on either of the switches.\n* `Complete` - Both switch profiles of the cluster profile are deployed.\n* `Partial` - Only one of the switch profiles of the cluster profile is deployed.", "type": "string", "enum": [ "None", "Complete", "Partial" ], "default": "None", "readOnly": true, "x-omitempty": true }, "DeployedSwitches": { "description": "The property which determines if the deployment should be skipped on any of the Fabric Interconnects. It is set based on the state of a fabric interconnect to Intersight before the deployment of the server proile begins.\n* `None` - Server profile configuration not deployed on either of the fabric interconnects.\n* `AB` - Server profile configuration deployed on both fabric interconnects.\n* `A` - Server profile configuration deployed on fabric interconnect A only.\n* `B` - Server profile configuration deployed on fabric interconnect B only.", "type": "string", "enum": [ "None", "AB", "A", "B" ], "default": "None", "readOnly": true, "x-omitempty": true }, "InitialAutoDeployConfigComplete": { "description": "Used with initialAutoDeployState to indicate if the server profile is ready for auto-deploy for the first time. The default value is false.", "type": "boolean", "x-omitempty": true }, "InitialAutoDeployMode": { "description": "Automatically performs an initial deployment when a server is assigned. Subsequent changes require manual redeployment.", "type": "boolean", "x-omitempty": true }, "InitialAutoDeployState": { "description": "The auto-deploy state of the server profile. It is used to track the state of the auto-deploy process.\n* `None` - Default value for Auto-deploy state when it is not configured and old server profiles.\n* `Pending` - Server profile is ready for autodeploy but not yet scheduled for deployment.\n* `AutoDeployPending` - AutoDeployPending is set when auto-deploy is yet to be scheduled.\n* `AutoDeployInProgress` - AutoDeployInProgress is set when auto-deploy action is in progress.\n* `AutoActivationPending` - AutoActivationPending is set when auto-deploy is yet to be scheduled.\n* `AutoActivationInProgress` - AutoActivationInProgress set when auto-deploy-activate action is in progress.\n* `Completed` - Completed states that all the auto deploy actions are completed successfully.\n* `Failed` - Failed states that one of the auto deploy actions failed.\n* `Unsupported` - Unsupported for direct server assignment and unassigned profiles.", "type": "string", "enum": [ "None", "Pending", "AutoDeployPending", "AutoDeployInProgress", "AutoActivationPending", "AutoActivationInProgress", "Completed", "Failed", "Unsupported" ], "default": "None", "readOnly": true, "x-omitempty": true }, "InternalReservationReferences": { "type": "array", "items": { "description": "The collection of reservation references created internally to preserve identifiers. Identifiers need to be preserved in the following scenarios:\nWhen policies of the same type are swapped within a profile or a profile template.\nWhen policy configured to use static identifiers is edited to use dynamic identifiers from a pool.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsPmcDeployedSecurePassphraseSet": { "description": "Indicates whether the value of the 'pmcDeployedSecurePassphrase' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "LocationDetails": { "description": "Location details associated with the managed object. When a top level resource is assigned to a location, the details of the associated location are propagated to related inventory and configuration objects like servers, profiles, alarms and metrics to facilitate location based filtering.", "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/comm.GeoLocationDetails", "readOnly": true, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PmcDeployedSecurePassphrase": { "description": "Secure passphrase that is already deployed on all the Persistent Memory Modules on the server. This deployed passphrase is required during deploy of server profile if secure passphrase is changed or security is disabled in the attached persistent memory policy.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PostDeployAction": { "type": "array", "items": { "description": "The action to be performed at the end of server profile deployment.\n* `None` - No action will be performed at the end of server profile deployment for this value.\n* `TriggerUpdatePcieDevicesInventory` - Initiate the update PCIe devices inventory workflow for this value.", "type": "string", "enum": [ "None", "TriggerUpdatePcieDevicesInventory" ], "default": "None", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ReservationReferences": { "type": "array", "items": { "description": "The collection of references to reservations that should be used while allocating identities.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference", "x-omitempty": true }, "nullable": true }, "ScheduledServerAssignment": { "description": "Server reassignment information that is captured as part of the config import process.", "$ref": "#/components/schemas/server.ServerAssignment", "x-omitempty": true }, "ServerAssignmentMode": { "description": "Source of the server assigned to the Server Profile. Values can be Static, Pool or None. Static is used if a server is attached directly to a Server Profile. Pool is used if a resource pool is attached to a Server Profile. None is used if no server or resource pool is attached to a Server Profile. Slot or Serial pre-assignment is also considered to be None as it is different form of Assign Later.\n* `None` - No server is assigned to the server profile.\n* `Static` - Server is directly assigned to server profile using assign server.\n* `Pool` - Server is assigned from a resource pool.", "type": "string", "enum": [ "None", "Static", "Pool" ], "default": "None", "x-omitempty": true }, "ServerPreAssignBySerial": { "description": "Serial number of the server that would be assigned to this pre-assigned Server Profile. It can be any string that adheres to the following constraints:\nIt should start and end with an alphanumeric character.\nIt cannot be more than 20 characters.", "type": "string", "pattern": "^[a-zA-Z0-9]{0,20}$", "x-omitempty": true }, "ServerPreAssignBySlot": { "description": "Server profile is pre-assigned to a server using slot.", "$ref": "#/components/schemas/server.ServerAssignTypeSlot", "x-omitempty": true }, "ServerReservation": { "description": "Serial number based reservation for the server to be assigned to this Server Profile.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resourcepool.ReservationReference", "x-omitempty": true }, "StaticUuidAddress": { "description": "The UUID address for the server must include UUID prefix xxxxxxxx-xxxx-xxxx along with the UUID suffix of format xxxx-xxxxxxxxxxxx.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "UndeployWfTasks": { "type": "array", "items": { "description": "List of undeploy task names that need to be executed during selective undeploy workflow for Standalone servers.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "UserLabel": { "description": "User label assigned to the server profile.", "type": "string", "pattern": "^[ !#$%&\\(\\)\\*\\+,\\-\\./:;\\?@\\[\\]_\\{\\|\\}~a-zA-Z0-9]*$", "minLength": 0, "maxLength": 64, "x-omitempty": true }, "Uuid": { "description": "The UUID address that is assigned to the server based on the UUID pool.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssignedServer": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "AssociatedServer": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "AssociatedServerPool": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resourcepool.Pool.Relationship", "description": "A reference to a resourcepoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ConfigChangeDetails": { "description": "An array of relationships to serverConfigChangeDetail resources.", "type": "array", "items": { "$ref": "#/components/schemas/server.ConfigChangeDetail.Relationship" }, "nullable": true, "readOnly": true }, "LeasedServer": { "$ref": "#/components/schemas/compute.Physical.Relationship", "description": "A reference to a computePhysical resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "ResourceLease": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resourcepool.Lease.Relationship", "description": "A reference to a resourcepoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningWorkflows": { "description": "An array of relationships to workflowWorkflowInfo resources.", "type": "array", "items": { "$ref": "intersight-orchestrator-v3-1.0.11-20260807064027971.json#/components/schemas/workflow.WorkflowInfo.Relationship" }, "nullable": true, "readOnly": true }, "ServerPool": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/resourcepool.Pool.Relationship", "description": "A reference to a resourcepoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "UuidLease": { "$ref": "#/components/schemas/uuidpool.UuidLease.Relationship", "description": "A reference to a uuidpoolUuidLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "server.Profile.List": { "title": "List of 'server.Profile' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.Profile' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.Profile' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.Profile" }, "nullable": true } } } ] }, "server.ProfilePendingChangeEval.Response": { "description": "The response body of a HTTP GET request for the 'server.ProfilePendingChangeEval' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ProfilePendingChangeEval' resources.", "x-one-of-name": "server.ProfilePendingChangeEval.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ProfilePendingChangeEval.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ProfilePendingChangeEval": { "title": "Server:Profile Pending Change Eval", "description": "Captures details of a pending policy change evaluation.", "x-allOf-name": "server.ProfilePendingChangeEval", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPendingChangeEval" } ] }, "server.ProfilePendingChangeEval.List": { "title": "List of 'server.ProfilePendingChangeEval' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ProfilePendingChangeEval' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ProfilePendingChangeEval' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ProfilePendingChangeEval" }, "nullable": true } } } ] }, "server.ProfileTemplate.Response": { "description": "The response body of a HTTP GET request for the 'server.ProfileTemplate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'server.ProfileTemplate' resources.", "x-one-of-name": "server.ProfileTemplate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/server.ProfileTemplate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "server.ProfileTemplate": { "title": "Server Profile Template", "description": "The ProfileTemplate object is an essential element in configuration management, providing a templated approach to server profile creation and updates. This simplifies the management of server profiles by allowing standardized configurations to be reused across multiple instances. \n#### Purpose \nProfileTemplate serves as the blueprint for creating server profiles, enabling efficient configuration management and consistency across deployments. It allows bulk operations such as cloning and updating profiles based on template changes. \n#### Key Concepts\n- **Template-Based Management:** Offers a structured approach to server configuration by establishing baseline settings that can be propagated to derived profiles. \n- **Bulk Operations:** Supports asynchronous operations such as cloning and updating, facilitating large-scale management of server profiles. \n- **Version Control:** Ensures template modifications are safely propagated to profiles without compromising existing configurations.\n- **Access Governance:** Privilege sets govern access to the template, maintaining secure control over server configuration processes.", "x-allOf-name": "server.ProfileTemplate", "allOf": [ { "$ref": "#/components/schemas/server.BaseProfile" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ProfileTemplate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ProfileTemplate" ], "default": "server.ProfileTemplate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ProfileTemplate" ], "default": "server.ProfileTemplate", "x-enum-as-string": true }, "EnableOverride": { "description": "When enabled, the configuration of the derived instances may override the template configuration.", "type": "boolean", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action from the current template only to failed objects (syncFailed).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync template action, there can be two action parameters-\nname-SyncType, value-SyncFailed.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "UpdateStatus": { "description": "The template sync status with all derived objects.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "The count of the server profiles derived from the template.", "deprecated": true, "x-sunset": "2027-03-01", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "readOnly": true, "x-omitempty": true }, "UsageCount": { "description": "The number of objects derived from a Template MO instance.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "server.ProfileTemplate.List": { "title": "List of 'server.ProfileTemplate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'server.ProfileTemplate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'server.ProfileTemplate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/server.ProfileTemplate" }, "nullable": true } } } ] }, "server.ServerAssignTypeSlot": { "title": "Server:Server Assign Type Slot", "description": "Server profile pre-assignment by slot.", "x-allOf-name": "server.ServerAssignTypeSlot", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ServerAssignTypeSlot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ServerAssignTypeSlot" ], "default": "server.ServerAssignTypeSlot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ServerAssignTypeSlot" ], "default": "server.ServerAssignTypeSlot", "x-enum-as-string": true }, "ChassisId": { "description": "Chassis-id of the slot that would be assigned to this pre-assigned server profile.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 40, "x-omitempty": true }, "DomainName": { "description": "The domain name of the Fabric Interconnect or the chassis name prefix.\nThe name must start and end with an alphanumeric character, can include underscores and hyphens, and has a maximum length of 30 characters.", "type": "string", "pattern": "^[a-zA-Z0-9_\\-]{0,30}$", "x-omitempty": true }, "SlotId": { "description": "Slot-id of the server that would be assigned to this pre-assigned server profile.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 8, "x-omitempty": true } } } ] }, "server.ServerAssignment": { "title": "Server:Server Assignment", "description": "Server assignment information.", "x-allOf-name": "server.ServerAssignment", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'server.ServerAssignment', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "server.ServerAssignment" ], "default": "server.ServerAssignment", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "server.ServerAssignment" ], "default": "server.ServerAssignment", "x-enum-as-string": true }, "Enabled": { "description": "Indicates if this assignment is enabled.", "type": "boolean", "x-omitempty": true }, "PoolSelector": { "description": "Odata selector that resolves to the server pool to be used for assignment, if applicable.", "type": "string", "x-omitempty": true }, "ServerSerial": { "description": "Serial number of the server.", "type": "string", "x-omitempty": true }, "ServerType": { "description": "The object type of the server - blade or rack.", "type": "string", "x-omitempty": true } } } ] }, "smtp.Policy.Response": { "description": "The response body of a HTTP GET request for the 'smtp.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'smtp.Policy' resources.", "x-one-of-name": "smtp.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/smtp.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "smtp.Policy.Relationship": { "description": "A relationship to the 'smtp.Policy' resource, or the expanded 'smtp.Policy' resource, or the 'null' value.", "x-one-of-name": "smtp.Policy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/smtp.Policy" } ], "discriminator": { "propertyName": "ClassId" } }, "smtp.Policy": { "title": "SMTP", "description": "The SMTP Policy is a reusable policy for configuring the Simple Mail Transfer Protocol (SMTP) client on an endpoint, enabling it to send email alerts.\n#### Purpose\nThe purpose of this policy is to enable and standardize the configuration for email-based alerting from managed devices. Administrators can define an SMTP server, port, and authentication credentials, and specify a list of recipients who should receive email notifications for system faults.\n#### Key Concepts\n- **Email-Based Alerting:** Its core function is to configure an endpoint to send email alerts for hardware or system faults.\n- **Centralized Configuration:** The policy allows for a single, consistent SMTP configuration to be applied to multiple servers via profiles.\n- **Recipient and Severity Control:** Administrators can specify a list of email recipients and set the minimum fault severity level (e.g., critical, warning) that should trigger an email notification.", "x-allOf-name": "smtp.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'smtp.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "smtp.Policy" ], "default": "smtp.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "smtp.Policy" ], "default": "smtp.Policy", "x-enum-as-string": true }, "AuthPassword": { "description": "Authorization password for the process.", "type": "string", "pattern": "^[\\S+]{0,254}$", "writeOnly": true, "x-omitempty": true }, "EnableAuth": { "description": "If enabled, lets user input username and password.", "type": "boolean", "default": false, "x-omitempty": true }, "EnableTls": { "description": "If enabled, lets user input valid CA certificates for authorization.", "type": "boolean", "default": false, "x-omitempty": true }, "Enabled": { "description": "If enabled, controls the state of the SMTP client service on the managed device.", "type": "boolean", "default": true, "x-omitempty": true }, "IsAuthPasswordSet": { "description": "Indicates whether the value of the 'authPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "MinSeverity": { "description": "Minimum fault severity level to receive email notifications. Email notifications are sent for all faults whose severity is equal to or greater than the chosen level.\n* `critical` - Minimum severity to report is critical.\n* `condition` - Minimum severity to report is informational.\n* `warning` - Minimum severity to report is warning.\n* `minor` - Minimum severity to report is minor.\n* `major` - Minimum severity to report is major.", "type": "string", "enum": [ "critical", "condition", "warning", "minor", "major" ], "default": "critical", "x-omitempty": true }, "SenderEmail": { "description": "The email address entered here will be displayed as the from address (mail received from address) of all the SMTP mail alerts that are received. If not configured, the hostname of the server is used in the from address field.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "SmtpPort": { "description": "Port number used by the SMTP server for outgoing SMTP communication.", "type": "integer", "format": "int64", "default": 25, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "SmtpRecipients": { "type": "array", "items": { "description": "List of email addresses that will receive notifications for faults.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "nullable": true }, "SmtpServer": { "description": "IP address or hostname of the SMTP server. The SMTP server is used by the managed device to send email notifications.", "type": "string", "x-omitempty": true }, "UserName": { "description": "SMTP username from which email notification is sent.", "type": "string", "x-omitempty": true }, "ApplianceAccount": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Certificate": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.TrustPoint.Relationship", "description": "A reference to a iamTrustPoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "smtp.Policy.List": { "title": "List of 'smtp.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'smtp.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'smtp.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/smtp.Policy" }, "nullable": true } } } ] }, "smtp.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'smtp.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'smtp.PolicyInventory' resources.", "x-one-of-name": "smtp.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/smtp.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "smtp.PolicyInventory": { "title": "SMTP", "description": "The SMTP Policy is a reusable policy for configuring the Simple Mail Transfer Protocol (SMTP) client on an endpoint, enabling it to send email alerts.\n#### Purpose\nThe purpose of this policy is to enable and standardize the configuration for email-based alerting from managed devices. Administrators can define an SMTP server, port, and authentication credentials, and specify a list of recipients who should receive email notifications for system faults.\n#### Key Concepts\n- **Email-Based Alerting:** Its core function is to configure an endpoint to send email alerts for hardware or system faults.\n- **Centralized Configuration:** The policy allows for a single, consistent SMTP configuration to be applied to multiple servers via profiles.\n- **Recipient and Severity Control:** Administrators can specify a list of email recipients and set the minimum fault severity level (e.g., critical, warning) that should trigger an email notification.", "x-allOf-name": "smtp.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'smtp.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "smtp.PolicyInventory" ], "default": "smtp.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "smtp.PolicyInventory" ], "default": "smtp.PolicyInventory", "x-enum-as-string": true }, "AuthPassword": { "description": "Authorization password for the process.", "type": "string", "pattern": "^[\\S+]{0,254}$", "writeOnly": true, "x-omitempty": true }, "EnableAuth": { "description": "If enabled, lets user input username and password.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "EnableTls": { "description": "If enabled, lets user input valid CA certificates for authorization.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "If enabled, controls the state of the SMTP client service on the managed device.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "IsAuthPasswordSet": { "description": "Indicates whether the value of the 'authPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "MinSeverity": { "description": "Minimum fault severity level to receive email notifications. Email notifications are sent for all faults whose severity is equal to or greater than the chosen level.\n* `critical` - Minimum severity to report is critical.\n* `condition` - Minimum severity to report is informational.\n* `warning` - Minimum severity to report is warning.\n* `minor` - Minimum severity to report is minor.\n* `major` - Minimum severity to report is major.", "type": "string", "enum": [ "critical", "condition", "warning", "minor", "major" ], "default": "critical", "readOnly": true, "x-omitempty": true }, "SenderEmail": { "description": "The email address entered here will be displayed as the from address (mail received from address) of all the SMTP mail alerts that are received. If not configured, the hostname of the server is used in the from address field.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "readOnly": true, "x-omitempty": true }, "SmtpPort": { "description": "Port number used by the SMTP server for outgoing SMTP communication.", "type": "integer", "format": "int64", "default": 25, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "SmtpRecipients": { "type": "array", "items": { "description": "List of email addresses that will receive notifications for faults.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SmtpServer": { "description": "IP address or hostname of the SMTP server. The SMTP server is used by the managed device to send email notifications.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserName": { "description": "SMTP username from which email notification is sent.", "type": "string", "readOnly": true, "x-omitempty": true }, "Certificate": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.TrustPoint.Relationship", "description": "A reference to a iamTrustPoint resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "smtp.PolicyInventory.List": { "title": "List of 'smtp.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'smtp.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'smtp.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/smtp.PolicyInventory" }, "nullable": true } } } ] }, "smtp.PolicyTest.Response": { "description": "The response body of a HTTP GET request for the 'smtp.PolicyTest' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'smtp.PolicyTest' resources.", "x-one-of-name": "smtp.PolicyTest.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/smtp.PolicyTest.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "smtp.PolicyTest": { "title": "SMTP Test", "description": "The PolicyTest object is designed to assist with the testing of SMTP policy compliance within Intersight Appliance, providing a mechanism for Account Administrators to verify the effectiveness of their email notification configurations.\n#### Purpose\nPolicyTest serves as a tool for sending test emails to validate SMTP policy settings. It ensures that email notifications are configured correctly, allowing administrators to troubleshoot and refine their notification strategies.\n#### Key Concepts\n- **SMTP Policy Verification:** Enables testing of SMTP configurations by sending test emails, helping administrators ensure compliance and correct settings.\n- **Account Administrator Access:** Specifically available to Account Administrators, enabling them to manage email settings and perform tests.\n- **Troubleshooting Support:** Provides detailed feedback on test results, including error specifics, to assist in resolving SMTP policy issues.", "x-allOf-name": "smtp.PolicyTest", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'smtp.PolicyTest', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "smtp.PolicyTest" ], "default": "smtp.PolicyTest", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "smtp.PolicyTest" ], "default": "smtp.PolicyTest", "x-enum-as-string": true }, "Enabled": { "description": "If enabled, an attempt will be made to send a test email notification to the configured recipients.", "type": "boolean", "default": true, "x-omitempty": true }, "LastStatusDetails": { "description": "Information on the last status, including any encountered error specifics, to assist users in troubleshooting SMTP policy issues.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastSuccessfulAttemptTime": { "description": "The date and time of the most recent successful attempt to send a test email notification.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastSuccessfulPolicy": { "description": "The SMTP policy of the most recent successful attempt to send a test email notification.", "nullable": true, "readOnly": true, "x-omitempty": true }, "LastTestStatus": { "description": "Status of the last test email notification.\n* `` - Notification has not been tried.\n* `failed` - Sending notification failed.\n* `success` - Sending notification successful.", "type": "string", "enum": [ "", "failed", "success" ], "default": "", "readOnly": true, "x-omitempty": true }, "Recipients": { "type": "array", "items": { "description": "List of email addresses that will receive the test email notification.", "type": "string", "pattern": "^$|^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$", "x-omitempty": true }, "minItems": 1, "nullable": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Policy": { "$ref": "#/components/schemas/smtp.Policy.Relationship", "description": "A reference to a smtpPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "smtp.PolicyTest.List": { "title": "List of 'smtp.PolicyTest' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'smtp.PolicyTest' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'smtp.PolicyTest' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/smtp.PolicyTest" }, "nullable": true } } } ] }, "snmp.Policy.Response": { "description": "The response body of a HTTP GET request for the 'snmp.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'snmp.Policy' resources.", "x-one-of-name": "snmp.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/snmp.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "snmp.Policy": { "title": "SNMP", "description": "The SNMP Policy is a reusable policy for configuring Simple Network Management Protocol (SNMP) settings on endpoints like servers and chassis.\n#### Purpose\nThe purpose of this policy is to enable and standardize device monitoring and management via SNMP. It allows administrators to configure the SNMP agent on bghendpoints, define access credentials for different SNMP versions, and specify destinations for SNMP traps, integrating the devices into existing network management systems.\n#### Key Concepts\n- **Multi-Version Support:** The policy allows for the independent configuration of SNMPv2c and SNMPv3, including enabling or disabling each version.\n- **User and Community Strings:** It supports the configuration of read-only community strings for SNMPv2c and detailed user-based security models (USM) for SNMPv3, including authentication and privacy protocols.\n- **Trap Configuration:** Administrators can define a list of trap destinations, specifying the recipient's address, port, and the SNMP version to use for the trap messages.\n- **Profile-Based Application:** The policy is attached to Server or Chassis Profiles to apply a consistent SNMP configuration across multiple devices.", "x-allOf-name": "snmp.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'snmp.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "snmp.Policy" ], "default": "snmp.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "snmp.Policy" ], "default": "snmp.Policy", "x-enum-as-string": true }, "AccessCommunityString": { "description": "The default SNMPv1, SNMPv2c community name or SNMPv3 username to include on any trap messages sent to the SNMP host. The name can be 32 characters long.", "type": "string", "maxLength": 32, "x-omitempty": true }, "CommunityAccess": { "description": "Controls access to the information in the inventory tables. Applicable only for SNMPv1 and SNMPv2c users.\n* `Disabled` - Blocks access to the information in the inventory tables.\n* `Limited` - Partial access to read the information in the inventory tables.\n* `Full` - Full access to read the information in the inventory tables.", "type": "string", "enum": [ "Disabled", "Limited", "Full" ], "default": "Disabled", "x-omitempty": true }, "Enabled": { "description": "State of the SNMP Policy on the endpoint. If enabled, the endpoint sends SNMP traps to the designated host.", "type": "boolean", "default": true, "x-omitempty": true }, "EngineId": { "description": "User-defined unique identification of the static engine.", "type": "string", "pattern": "^[^#!&]*$", "maxLength": 27, "x-omitempty": true }, "SnmpPort": { "description": "Port on which Cisco IMC SNMP agent runs. Enter a value between 1-65535. Reserved ports not allowed (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).", "type": "integer", "format": "int64", "default": 161, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "SnmpTraps": { "type": "array", "items": { "description": "List of SNMP traps for the policy.", "$ref": "#/components/schemas/snmp.Trap", "x-omitempty": true }, "maxItems": 15, "nullable": true }, "SnmpUsers": { "type": "array", "items": { "description": "List of SNMP users for the policy.", "$ref": "#/components/schemas/snmp.User", "x-omitempty": true }, "maxItems": 15, "nullable": true }, "SysContact": { "description": "Contact person responsible for the SNMP implementation. Enter a string up to 64 characters, such as an email address or a name and telephone number.", "type": "string", "maxLength": 64, "x-omitempty": true }, "SysLocation": { "description": "Location of host on which the SNMP agent (server) runs.", "type": "string", "maxLength": 64, "x-omitempty": true }, "TrapCommunity": { "description": "SNMP community group used for sending SNMP trap to other devices. Valid only for SNMPv2c users.", "type": "string", "maxLength": 32, "x-omitempty": true }, "V2Enabled": { "description": "State of the SNMP v2c on the endpoint. If enabled, the endpoint sends SNMP v2c properties to the designated host.", "type": "boolean", "default": true, "x-omitempty": true }, "V3Enabled": { "description": "State of the SNMP v3 on the endpoint. If enabled, the endpoint sends SNMP v3 properties to the designated host.", "type": "boolean", "default": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "snmp.Policy.List": { "title": "List of 'snmp.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'snmp.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'snmp.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/snmp.Policy" }, "nullable": true } } } ] }, "snmp.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'snmp.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'snmp.PolicyInventory' resources.", "x-one-of-name": "snmp.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/snmp.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "snmp.PolicyInventory": { "title": "SNMP", "description": "The SNMP Policy is a reusable policy for configuring Simple Network Management Protocol (SNMP) settings on endpoints like servers and chassis.\n#### Purpose\nThe purpose of this policy is to enable and standardize device monitoring and management via SNMP. It allows administrators to configure the SNMP agent on bghendpoints, define access credentials for different SNMP versions, and specify destinations for SNMP traps, integrating the devices into existing network management systems.\n#### Key Concepts\n- **Multi-Version Support:** The policy allows for the independent configuration of SNMPv2c and SNMPv3, including enabling or disabling each version.\n- **User and Community Strings:** It supports the configuration of read-only community strings for SNMPv2c and detailed user-based security models (USM) for SNMPv3, including authentication and privacy protocols.\n- **Trap Configuration:** Administrators can define a list of trap destinations, specifying the recipient's address, port, and the SNMP version to use for the trap messages.\n- **Profile-Based Application:** The policy is attached to Server or Chassis Profiles to apply a consistent SNMP configuration across multiple devices.", "x-allOf-name": "snmp.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'snmp.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "snmp.PolicyInventory" ], "default": "snmp.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "snmp.PolicyInventory" ], "default": "snmp.PolicyInventory", "x-enum-as-string": true }, "AccessCommunityString": { "description": "The default SNMPv1, SNMPv2c community name or SNMPv3 username to include on any trap messages sent to the SNMP host. The name can be 32 characters long.", "type": "string", "maxLength": 32, "readOnly": true, "x-omitempty": true }, "CommunityAccess": { "description": "Controls access to the information in the inventory tables. Applicable only for SNMPv1 and SNMPv2c users.\n* `Disabled` - Blocks access to the information in the inventory tables.\n* `Limited` - Partial access to read the information in the inventory tables.\n* `Full` - Full access to read the information in the inventory tables.", "type": "string", "enum": [ "Disabled", "Limited", "Full" ], "default": "Disabled", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "State of the SNMP Policy on the endpoint. If enabled, the endpoint sends SNMP traps to the designated host.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "EngineId": { "description": "User-defined unique identification of the static engine.", "type": "string", "pattern": "^[^#!&]*$", "maxLength": 27, "readOnly": true, "x-omitempty": true }, "SnmpPort": { "description": "Port on which Cisco IMC SNMP agent runs. Enter a value between 1-65535. Reserved ports not allowed (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).", "type": "integer", "format": "int64", "default": 161, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "SnmpTraps": { "type": "array", "items": { "description": "List of SNMP traps for the policy.", "$ref": "#/components/schemas/snmp.Trap", "readOnly": true, "x-omitempty": true }, "maxItems": 15, "nullable": true }, "SnmpUsers": { "type": "array", "items": { "description": "List of SNMP users for the policy.", "$ref": "#/components/schemas/snmp.User", "readOnly": true, "x-omitempty": true }, "maxItems": 15, "nullable": true }, "SysContact": { "description": "Contact person responsible for the SNMP implementation. Enter a string up to 64 characters, such as an email address or a name and telephone number.", "type": "string", "maxLength": 64, "readOnly": true, "x-omitempty": true }, "SysLocation": { "description": "Location of host on which the SNMP agent (server) runs.", "type": "string", "maxLength": 64, "readOnly": true, "x-omitempty": true }, "TrapCommunity": { "description": "SNMP community group used for sending SNMP trap to other devices. Valid only for SNMPv2c users.", "type": "string", "maxLength": 32, "readOnly": true, "x-omitempty": true }, "V2Enabled": { "description": "State of the SNMP v2c on the endpoint. If enabled, the endpoint sends SNMP v2c properties to the designated host.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "V3Enabled": { "description": "State of the SNMP v3 on the endpoint. If enabled, the endpoint sends SNMP v3 properties to the designated host.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "snmp.PolicyInventory.List": { "title": "List of 'snmp.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'snmp.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'snmp.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/snmp.PolicyInventory" }, "nullable": true } } } ] }, "snmp.Trap": { "title": "Snmp:Trap", "description": "Complex type that models a trap message sent from an agent to the manager.", "x-allOf-name": "snmp.Trap", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'snmp.Trap', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "snmp.Trap" ], "default": "snmp.Trap", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "snmp.Trap" ], "default": "snmp.Trap", "x-enum-as-string": true }, "Community": { "description": "SNMP community group used for sending SNMP trap to other devices. Applicable only for SNMP v2c.", "type": "string", "maxLength": 32, "x-omitempty": true }, "Destination": { "description": "Address to which the SNMP trap information is sent.", "type": "string", "x-omitempty": true }, "Enabled": { "description": "Enables/disables the trap on the server If enabled, trap is active on the server.", "type": "boolean", "default": true, "x-omitempty": true }, "Port": { "description": "Port used by the server to communicate with the trap destination. Enter a value between 1-65535. Reserved ports not allowed (22, 23, 80, 123, 389, 443, 623, 636, 2068, 3268, 3269).", "type": "integer", "format": "int64", "default": 162, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "SecurityLevel": { "description": "Security level of the trap receiver used for communication.\n* `AuthPriv` - The user requires both an authorization password and a privacy password.\n* `NoAuthNoPriv` - The user does not require an authorization or privacy password.\n* `AuthNoPriv` - The user requires an authorization password but not a privacy password.", "type": "string", "enum": [ "AuthPriv", "NoAuthNoPriv", "AuthNoPriv" ], "default": "AuthPriv", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of trap which decides whether to receive a notification when a trap is received at the destination.\n* `Trap` - Do not receive notifications when trap is sent to the destination.\n* `Inform` - Receive notifications when trap is sent to the destination. This option is valid only for V2 users.", "type": "string", "enum": [ "Trap", "Inform" ], "default": "Trap", "x-omitempty": true }, "User": { "description": "SNMP user for the trap. Applicable only to SNMPv3.", "type": "string", "x-omitempty": true }, "Version": { "description": "SNMP version used for the trap.\n* `V3` - SNMP v3 trap version notifications.\n* `V1` - SNMP v1 trap version notifications.\n* `V2` - SNMP v2 trap version notifications.", "type": "string", "enum": [ "V3", "V1", "V2" ], "default": "V3", "x-omitempty": true }, "VrfName": { "description": "VRF name of the SNMP server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "snmp.User": { "title": "Snmp:User", "description": "Complex type for a User based security model, for communication between an agent and manager. Applicable only for SNMPv3.", "x-allOf-name": "snmp.User", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'snmp.User', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "snmp.User" ], "default": "snmp.User", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "snmp.User" ], "default": "snmp.User", "x-enum-as-string": true }, "AuthPassword": { "description": "Authorization password for the user.", "type": "string", "writeOnly": true, "x-omitempty": true }, "AuthType": { "description": "Authorization protocol for authenticating the user.\n* `NA` - Authentication protocol is not applicable.\n* `MD5` - MD5 protocol is used to authenticate SNMP user.\n* `SHA` - SHA protocol is used to authenticate SNMP user.\n* `SHA-224` - SHA-224 protocol is used to authenticate SNMP user.\n* `SHA-256` - SHA-256 protocol is used to authenticate SNMP user.\n* `SHA-384` - SHA-384 protocol is used to authenticate SNMP user.\n* `SHA-512` - SHA-512 protocol is used to authenticate SNMP user.", "type": "string", "enum": [ "NA", "MD5", "SHA", "SHA-224", "SHA-256", "SHA-384", "SHA-512" ], "default": "NA", "x-omitempty": true }, "IsAuthPasswordSet": { "description": "Indicates whether the value of the 'authPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsPrivacyPasswordSet": { "description": "Indicates whether the value of the 'privacyPassword' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Name": { "description": "SNMP username. Must have a minimum of 1 and and a maximum of 31 characters.", "type": "string", "minLength": 1, "maxLength": 31, "x-omitempty": true }, "PrivacyPassword": { "description": "Privacy password for the user.", "type": "string", "writeOnly": true, "x-omitempty": true }, "PrivacyType": { "description": "Privacy protocol for the user.\n* `NA` - Privacy protocol is not applicable.\n* `DES` - DES privacy protocol is used for SNMP user.\n* `AES` - AES privacy protocol is used for SNMP user.", "type": "string", "enum": [ "NA", "DES", "AES" ], "default": "NA", "x-omitempty": true }, "SecurityLevel": { "description": "Security mechanism used for communication between agent and manager.\n* `AuthPriv` - The user requires both an authorization password and a privacy password.\n* `NoAuthNoPriv` - The user does not require an authorization or privacy password.\n* `AuthNoPriv` - The user requires an authorization password but not a privacy password.", "type": "string", "enum": [ "AuthPriv", "NoAuthNoPriv", "AuthNoPriv" ], "default": "AuthPriv", "x-omitempty": true } } } ] }, "sol.Policy.Response": { "description": "The response body of a HTTP GET request for the 'sol.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sol.Policy' resources.", "x-one-of-name": "sol.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sol.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sol.Policy": { "title": "Serial Over LAN", "description": "The SOL Policy is a reusable policy for configuring the Serial Over LAN (SOL) service on a server's management controller.\n#### Purpose\nThe purpose of this policy is to enable and standardize out-of-band access to a server's serial console. This provides a low-level, text-based interface for server management and troubleshooting, which is particularly useful when the primary network or graphical console is unavailable.\n#### Key Concepts\n- **Service Control:** The policy allows administrators to enable or disable the SOL service on the endpoint.\n- **Communication Parameters:** This provides options to configure the baudRate and comPort to ensure compatibility with the server's operating system and terminal clients.\n- **Direct SSH Access:** A key feature is the ability to configure a dedicated sshPort for SOL, which allows administrators to bypass the main CIMC shell and connect directly to the serial console via SSH.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply a consistent SOL configuration across multiple servers.", "x-allOf-name": "sol.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'sol.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sol.Policy" ], "default": "sol.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sol.Policy" ], "default": "sol.Policy", "x-enum-as-string": true }, "BaudRate": { "description": "Baud Rate used for Serial Over LAN communication.\n* `9600` - Use baud rate 9600 for communication.\n* `19200` - Use baud rate 19200 for communication.\n* `38400` - Use baud rate 38400 for communication.\n* `57600` - Use baud rate 57600 for communication.\n* `115200` - Use baud rate 115200 for communication.", "type": "integer", "enum": [ 9600, 19200, 38400, 57600, 115200 ], "default": 9600, "x-omitempty": true }, "ComPort": { "description": "Serial port through which the system routes Serial Over LAN communication. This field is available only on some Cisco UCS C-Series servers. If it is unavailable, the server uses COM port 0 by default.\n* `com0` - Use serial port com0 for communication.\n* `com1` - Use serial port com1 for communication.", "type": "string", "enum": [ "com0", "com1" ], "default": "com0", "x-omitempty": true }, "Enabled": { "description": "State of Serial Over LAN service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "SshPort": { "description": "SSH port used to access Serial Over LAN directly. Enables bypassing Cisco IMC shell to provide direct access to Serial Over LAN.", "type": "integer", "format": "int64", "default": 2400, "minimum": 1024, "maximum": 65535, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "sol.Policy.List": { "title": "List of 'sol.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sol.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sol.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sol.Policy" }, "nullable": true } } } ] }, "sol.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'sol.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'sol.PolicyInventory' resources.", "x-one-of-name": "sol.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/sol.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "sol.PolicyInventory": { "title": "Serial Over LAN", "description": "The SOL Policy is a reusable policy for configuring the Serial Over LAN (SOL) service on a server's management controller.\n#### Purpose\nThe purpose of this policy is to enable and standardize out-of-band access to a server's serial console. This provides a low-level, text-based interface for server management and troubleshooting, which is particularly useful when the primary network or graphical console is unavailable.\n#### Key Concepts\n- **Service Control:** The policy allows administrators to enable or disable the SOL service on the endpoint.\n- **Communication Parameters:** This provides options to configure the baudRate and comPort to ensure compatibility with the server's operating system and terminal clients.\n- **Direct SSH Access:** A key feature is the ability to configure a dedicated sshPort for SOL, which allows administrators to bypass the main CIMC shell and connect directly to the serial console via SSH.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply a consistent SOL configuration across multiple servers.", "x-allOf-name": "sol.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'sol.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "sol.PolicyInventory" ], "default": "sol.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "sol.PolicyInventory" ], "default": "sol.PolicyInventory", "x-enum-as-string": true }, "BaudRate": { "description": "Baud Rate used for Serial Over LAN communication.\n* `9600` - Use baud rate 9600 for communication.\n* `19200` - Use baud rate 19200 for communication.\n* `38400` - Use baud rate 38400 for communication.\n* `57600` - Use baud rate 57600 for communication.\n* `115200` - Use baud rate 115200 for communication.", "type": "integer", "enum": [ 9600, 19200, 38400, 57600, 115200 ], "default": 9600, "readOnly": true, "x-omitempty": true }, "ComPort": { "description": "Serial port through which the system routes Serial Over LAN communication. This field is available only on some Cisco UCS C-Series servers. If it is unavailable, the server uses COM port 0 by default.\n* `com0` - Use serial port com0 for communication.\n* `com1` - Use serial port com1 for communication.", "type": "string", "enum": [ "com0", "com1" ], "default": "com0", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "State of Serial Over LAN service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "SshPort": { "description": "SSH port used to access Serial Over LAN directly. Enables bypassing Cisco IMC shell to provide direct access to Serial Over LAN.", "type": "integer", "format": "int64", "default": 2400, "minimum": 1024, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "sol.PolicyInventory.List": { "title": "List of 'sol.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'sol.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'sol.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/sol.PolicyInventory" }, "nullable": true } } } ] }, "ssh.Policy.Response": { "description": "The response body of a HTTP GET request for the 'ssh.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ssh.Policy' resources.", "x-one-of-name": "ssh.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ssh.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ssh.Policy": { "title": "SSH", "description": "The SSH Policy is a reusable policy for configuring the Secure Shell (SSH) service on an endpoint's management controller.\n#### Purpose\nThe purpose of this policy is to enable and standardize secure command-line access to managed devices. It allows administrators to control the state of the SSH service, the network port it listens on, and the session timeout period, ensuring consistent and secure remote access.\n#### Key Concepts\n- **Service Control:** The policy's primary function is to enable or disable the SSH service on the endpoint.\n- **Port and Timeout Configuration:** It allows administrators to customize the SSH port and the session timeout duration in seconds.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to a Server Profile to apply a consistent SSH configuration across multiple servers.\n- **Fundamental Security:** Configuring SSH access is a fundamental step in securing the management plane of a server.", "x-allOf-name": "ssh.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'ssh.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ssh.Policy" ], "default": "ssh.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ssh.Policy" ], "default": "ssh.Policy", "x-enum-as-string": true }, "Enabled": { "description": "State of SSH service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "Port": { "description": "Port used for secure shell access.", "type": "integer", "format": "int64", "default": 22, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "Timeout": { "description": "Number of seconds to wait before the system considers a SSH request to have timed out.", "type": "integer", "format": "int64", "default": 1800, "minimum": 60, "maximum": 10800, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "ssh.Policy.List": { "title": "List of 'ssh.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ssh.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ssh.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ssh.Policy" }, "nullable": true } } } ] }, "ssh.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'ssh.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'ssh.PolicyInventory' resources.", "x-one-of-name": "ssh.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/ssh.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "ssh.PolicyInventory": { "title": "SSH", "description": "The SSH Policy is a reusable policy for configuring the Secure Shell (SSH) service on an endpoint's management controller.\n#### Purpose\nThe purpose of this policy is to enable and standardize secure command-line access to managed devices. It allows administrators to control the state of the SSH service, the network port it listens on, and the session timeout period, ensuring consistent and secure remote access.\n#### Key Concepts\n- **Service Control:** The policy's primary function is to enable or disable the SSH service on the endpoint.\n- **Port and Timeout Configuration:** It allows administrators to customize the SSH port and the session timeout duration in seconds.\n- **Reusable and Profile-Based:** As a policy object, it can be attached to a Server Profile to apply a consistent SSH configuration across multiple servers.\n- **Fundamental Security:** Configuring SSH access is a fundamental step in securing the management plane of a server.", "x-allOf-name": "ssh.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'ssh.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "ssh.PolicyInventory" ], "default": "ssh.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "ssh.PolicyInventory" ], "default": "ssh.PolicyInventory", "x-enum-as-string": true }, "Enabled": { "description": "State of SSH service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Port": { "description": "Port used for secure shell access.", "type": "integer", "format": "int64", "default": 22, "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "Timeout": { "description": "Number of seconds to wait before the system considers a SSH request to have timed out.", "type": "integer", "format": "int64", "default": 1800, "minimum": 60, "maximum": 10800, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "ssh.PolicyInventory.List": { "title": "List of 'ssh.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'ssh.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'ssh.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/ssh.PolicyInventory" }, "nullable": true } } } ] }, "storage.AutomaticDriveGroup": { "title": "Storage:Automatic Drive Group", "description": "This models the automatic drive selection configuration.", "x-allOf-name": "storage.AutomaticDriveGroup", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.AutomaticDriveGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.AutomaticDriveGroup" ], "default": "storage.AutomaticDriveGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.AutomaticDriveGroup" ], "default": "storage.AutomaticDriveGroup", "x-enum-as-string": true }, "DriveType": { "description": "Type of drive that should be used for this RAID group.\n* `Any` - Any type of drive can be used for virtual drive creation.\n* `HDD` - Hard disk drives should be used for virtual drive creation.\n* `SSD` - Solid state drives should be used for virtual drive creation.", "type": "string", "enum": [ "Any", "HDD", "SSD" ], "default": "Any", "x-omitempty": true }, "DrivesPerSpan": { "description": "Number of drives within this span group. The minimum number of disks needed in a span group varies based on RAID level. RAID0 requires at least one disk. RAID1 and RAID10 requires at least 2 and in multiples of . RAID5 and RAID50 require at least 3 disks in a span group. RAID6 and RAID60 require atleast 4 disks in a span.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 100, "x-createOnly": true, "x-omitempty": true }, "MinimumDriveSize": { "description": "Minimum size of the drive to be used for creating this RAID group.", "type": "integer", "format": "int64", "x-createOnly": true, "x-omitempty": true }, "NumDedicatedHotSpares": { "description": "Number of dedicated hot spare disks for this RAID group. Allowed value is a comma or hyphen separated number range.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "NumberOfSpans": { "description": "Number of span groups to be created for this RAID group. Non-nested RAID levels have a single span.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 8, "x-createOnly": true, "x-omitempty": true }, "UseRemainingDrives": { "description": "This flag enables the drive group to use all the remaining drives on the server.", "type": "boolean", "x-omitempty": true } } } ] }, "storage.BaseArray.Relationship": { "description": "A relationship to the 'storage.BaseArray' resource, or the expanded 'storage.BaseArray' resource, or the 'null' value.", "x-one-of-name": "storage.BaseArray.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.BaseArray" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.BaseArray": { "title": "Storage:Base Array", "description": "Abstract object which contains common attributes of a storage array. Every storage array should inherit from this object.", "x-allOf-name": "storage.BaseArray", "allOf": [ { "$ref": "#/components/schemas/equipment.AbstractDevice" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiArray", "storage.NetAppCluster", "storage.PureArray", "storage.PureFlashBladeSystem" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiArray", "storage.NetAppCluster", "storage.PureArray", "storage.PureFlashBladeSystem" ], "x-enum-as-string": true }, "StorageUtilization": { "description": "Storage utilization of an array. It contains total capacity, available capacity, and used capacity.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseArrayController": { "title": "Storage:Base Array Controller", "description": "Common attributes for a Storage array controller. It can be a hardware or software unit which manages the physical storage disks available in the array.", "x-allOf-name": "storage.BaseArrayController", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseArrayController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiController", "storage.NetAppNode", "storage.PureController" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiController", "storage.NetAppNode", "storage.PureController" ], "x-enum-as-string": true }, "Name": { "description": "Storage array controller name.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperationalMode": { "description": "Controller running mode, Primary or Secondary.\n* `Unknown` - Component operational state is unknown.\n* `Primary` - Component operates in primary mode and accepts workloads.\n* `Secondary` - Component is running as a secondary or standby mode.\n* `Maintenance` - Component is in maintenance mode for upgrade. During maintenance mode, component does not perform any workload.", "type": "string", "enum": [ "Unknown", "Primary", "Secondary", "Maintenance" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the storage controller.\n* `Unknown` - Component status is not available.\n* `Ok` - Component is healthy and no issues found.\n* `Degraded` - Functioning, but not at full capability due to a non-fatal failure.\n* `Critical` - Not functioning or requiring immediate attention.\n* `Offline` - Component is installed, but powered off.\n* `Identifying` - Component is in initialization process.\n* `NotAvailable` - Component is not installed or not available.\n* `Updating` - Software update is in progress.\n* `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported.", "type": "string", "enum": [ "Unknown", "Ok", "Degraded", "Critical", "Offline", "Identifying", "NotAvailable", "Updating", "Unrecognized" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Software version running on a storage controller.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseArrayDisk": { "title": "Storage:Base Array Disk", "description": "Common attributes of a storage array disk.", "x-allOf-name": "storage.BaseArrayDisk", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseArrayDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.PureDisk" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiDisk", "storage.NetAppBaseDisk", "storage.PureDisk" ], "x-enum-as-string": true }, "Name": { "description": "Disk name available in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartNumber": { "description": "Storage disk part number.", "type": "string", "readOnly": true, "x-omitempty": true }, "Protocol": { "description": "Storage protocol used in disk for communication. Possible values are SAS, SATA and NVMe.\n* `Unknown` - Disk protocol is unknown.\n* `SAS` - Serial Attached SCSI protocol (SAS) used in disk.\n* `NVMe` - Non-volatile memory express (NVMe) protocol used in disk.\n* `SATA` - Serial Advanced Technology Attachment (SATA) used in disk.", "type": "string", "enum": [ "Unknown", "SAS", "NVMe", "SATA" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Speed": { "description": "Disk speed for read or write operation measured in rpm.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Storage disk health status.\n* `Unknown` - Component status is not available.\n* `Ok` - Component is healthy and no issues found.\n* `Degraded` - Functioning, but not at full capability due to a non-fatal failure.\n* `Critical` - Not functioning or requiring immediate attention.\n* `Offline` - Component is installed, but powered off.\n* `Identifying` - Component is in initialization process.\n* `NotAvailable` - Component is not installed or not available.\n* `Updating` - Software update is in progress.\n* `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported.", "type": "string", "enum": [ "Unknown", "Ok", "Degraded", "Critical", "Offline", "Identifying", "NotAvailable", "Updating", "Unrecognized" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Utilization information of the storage disk.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Storage disk type - it can be SSD, HDD, NVRAM.\n* `Unknown` - Default unknown disk type.\n* `SSD` - Storage disk with Solid state disk.\n* `HDD` - Storage disk with Hard disk drive.\n* `NVRAM` - Storage disk with Non-volatile random-access memory type.\n* `SATA` - Disk drive implementation with Serial Advanced Technology Attachment (SATA).\n* `BSAS` - Bridged SAS-SATA disks with added hardware to enable them to be plugged into a SAS-connected storage shelf.\n* `FC` - Storage disk with Fiber Channel.\n* `FSAS` - Near Line SAS. NL-SAS drives are enterprise SATA drives with a SAS interface, head, media, androtational speed of traditional enterprise-class SATA drives with the fully capable SAS interfacetypical for classic SAS drives.\n* `LUN` - Logical Unit Number refers to a logical disk.\n* `MSATA` - SATA disk in multi-disk carrier storage shelf.\n* `SAS` - Storage disk with serial attached SCSI.\n* `VMDISK` - Virtual machine Data Disk.", "type": "string", "enum": [ "Unknown", "SSD", "HDD", "NVRAM", "SATA", "BSAS", "FC", "FSAS", "LUN", "MSATA", "SAS", "VMDISK" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Storage disk version number.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseCapacity": { "title": "Storage:Base Capacity", "description": "Storage capacity information which includes, total capacity, available capacity, used capacity and free capacity.", "x-allOf-name": "storage.BaseCapacity", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseCapacity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiArrayUtilization", "storage.HitachiCapacity", "storage.NetAppStorageUtilization", "storage.PureArrayUtilization", "storage.PureDiskUtilization", "storage.PureFlashBladeUtilization", "storage.PureHostUtilization", "storage.PureVolumeUtilization", "storage.StorageContainerUtilization", "storage.VolumeUtilization" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiArrayUtilization", "storage.HitachiCapacity", "storage.NetAppStorageUtilization", "storage.PureArrayUtilization", "storage.PureDiskUtilization", "storage.PureFlashBladeUtilization", "storage.PureHostUtilization", "storage.PureVolumeUtilization", "storage.StorageContainerUtilization", "storage.VolumeUtilization" ], "x-enum-as-string": true }, "Available": { "description": "Total consumable storage capacity represented in bytes. System may reserve some space for internal purposes which is excluded from total capacity.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "CapacityUtilization": { "description": "Percentage of used capacity.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Free": { "description": "Unused space available for applications to consume, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Total": { "description": "Total storage capacity, represented in bytes. It is set by the component manufacturer.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Used": { "description": "Used or consumed storage capacity, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseCluster.Relationship": { "description": "A relationship to the 'storage.BaseCluster' resource, or the expanded 'storage.BaseCluster' resource, or the 'null' value.", "x-one-of-name": "storage.BaseCluster.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.BaseCluster" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.BaseCluster": { "title": "Storage:Base Cluster", "description": "The BaseCluster object represents common attributes of a storage cluster. It serves as a foundational element for storage management, enabling efficient handling and orchestration of storage resources within a clustered environment.\n#### Purpose\nThe BaseCluster object is designed to encapsulate general attributes shared among storage clusters, providing a consistent framework for storage management across various implementations. It supports a wide range of storage configurations, enabling organizations to manage storage resources seamlessly.\n#### Key Concepts\n- **Storage Management:** Acts as a container for various storage resources, ensuring efficient storage allocation and management within a cluster.\n- **Extensibility:** Provides a base structure that can be extended by more specialized storage cluster implementations, promoting reusability and modularity.\n- **Integration:** Facilitates integration with other storage management tools, enhancing the ability to manage storage clusters effectively and cohesively.", "x-allOf-name": "storage.BaseCluster", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/infra.BaseCluster" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseCluster', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Cluster" ], "default": "hyperflex.Cluster", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Cluster" ], "default": "hyperflex.Cluster", "x-enum-as-string": true }, "StorageCapacity": { "description": "The storage capacity in this cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ParentCluster": { "$ref": "#/components/schemas/compute.BaseCluster.Relationship", "description": "A reference to a computeBaseCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.BaseDiskPool": { "title": "Storage:Base Disk Pool", "description": "A disk pool is a set of drives that is logically grouped together in the storage array. Some storage vendors use pools extensively.", "x-allOf-name": "storage.BaseDiskPool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseDiskPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiPool", "storage.NetAppAggregate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiPool", "storage.NetAppAggregate" ], "x-enum-as-string": true }, "Name": { "description": "Human readable name of the pool, limited to 64 characters.", "type": "string", "readOnly": true, "x-omitempty": true }, "PoolId": { "description": "Object ID for the pool. Platforms that use a number should convert it to string.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Human readable status of the pool, indicating the current health.\n* `Unknown` - Entity status is unknown.\n* `Degraded` - State is degraded, and might impact normal operation of the entity.\n* `Critical` - Entity is in a critical state, impacting operations.\n* `Ok` - Entity status is in a stable state, operating normally.", "type": "string", "enum": [ "Unknown", "Degraded", "Critical", "Ok" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of the pool entity in a storage array.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Human readable type of the pool, such as thin, tiered, active-flash, etc.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseHost": { "title": "Storage:Base Host", "description": "Generic storage host object. It is a logical object to associate initiators to expose a volume as a LUN.", "x-allOf-name": "storage.BaseHost", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseHost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiHost", "storage.NetAppInitiatorGroup", "storage.PureHost" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiHost", "storage.NetAppInitiatorGroup", "storage.PureHost" ], "x-enum-as-string": true }, "Description": { "description": "Short description about the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "Initiators": { "type": "array", "items": { "description": "List of initiators which are associated with host.", "$ref": "#/components/schemas/storage.BaseInitiator", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "Name of the host in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "OsType": { "description": "Operating system running on the host.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of host entity in storage array.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseHostGroup": { "title": "Storage:Base Host Group", "description": "Generic representation for a group of hosts.", "x-allOf-name": "storage.BaseHostGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseHostGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.InitiatorGroup", "storage.PureHostGroup" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.InitiatorGroup", "storage.PureHostGroup" ], "x-enum-as-string": true }, "Description": { "description": "Short description about the host group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the host group in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of host group entity in storage array.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseHostLun": { "title": "Storage:Base Host Lun", "description": "Generic storage host lun object. It exists only if the volume is associated to host initiator.", "x-allOf-name": "storage.BaseHostLun", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseHostLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Lun", "storage.HitachiHostLun", "storage.NetAppLunMap", "storage.PureHostLun" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Lun", "storage.HitachiHostLun", "storage.NetAppLunMap", "storage.PureHostLun" ], "x-enum-as-string": true }, "Hlu": { "description": "Logical unit number (LUN) by which hosts address specified volume. Hlu is a decimal representation of the LUN from the endpoint.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "Name of the host associated with LUN.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "Name of the storage volume associated with LUN.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseInitiator": { "title": "Storage:Base Initiator", "description": "An initiator is the consumer of storage, typically a server with an adapter card in it called a Host Bus Adapter (HBA). The initiator \"initiates\" a connection over the fabric to one or more ports on storage system target ports.", "x-allOf-name": "storage.BaseInitiator", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseInitiator', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiInitiator", "storage.HyperFlexIscsiInitiator", "storage.Initiator" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiInitiator", "storage.HyperFlexIscsiInitiator", "storage.Initiator" ], "x-enum-as-string": true }, "Iqn": { "description": "IQN (iSCSI qualified name). Can be up to 255 characters long and has the format iqn.yyyy-mm.naming-authority:unique name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the initiator represented in the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "Nqn": { "description": "NQN (NVMe Qualified Name). Can be up to 223 characters long and has the format nqn.yyyy-mm.naming-authority:unique name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Initiator type, it can be FC or iSCSI.\n* `FC` - Fibre channel initiator type which contains WWN of an HBA on the host.\n* `iSCSI` - An iSCSI initiator type which contains the IQN (iSCSI Qualified Name) used by the host.\n* `NVMe` - NVMe initiator type which contains the NQN (NVMe Qualified Name) used by the host.\n* `Mixed` - Initiator type for systems using both FC and iSCSI connections.", "type": "string", "enum": [ "FC", "iSCSI", "NVMe", "Mixed" ], "default": "FC", "readOnly": true, "x-omitempty": true }, "Wwn": { "description": "World wide name, 128 bit address represented in hexadecimal notation. For example, 51:4f:0c:50:14:1f:af:01:51:4f:0c:51:14:1f:af:01.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseNfsExport": { "title": "Storage:Base Nfs Export", "description": "Generic NFS Export object.", "x-allOf-name": "storage.BaseNfsExport", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseNfsExport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppExportPolicy" ], "default": "storage.NetAppExportPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppExportPolicy" ], "default": "storage.NetAppExportPolicy", "x-enum-as-string": true }, "Name": { "description": "Name of the NFS export in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The uuid of this NFS export.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BasePerformanceMetricsAverage": { "title": "Storage:Base Performance Metrics Average", "description": "Average performance metrics data for a storage resource over a given period of time.", "x-allOf-name": "storage.BasePerformanceMetricsAverage", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BasePerformanceMetricsAverage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppPerformanceMetricsAverage" ], "default": "storage.NetAppPerformanceMetricsAverage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppPerformanceMetricsAverage" ], "default": "storage.NetAppPerformanceMetricsAverage", "x-enum-as-string": true }, "Iops": { "description": "Rate of I/O operations observed at the storage object.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true }, "Latency": { "description": "Latency observed at the storage object.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true }, "Period": { "description": "Duration of periodic aggregation, in hours.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Throughput": { "description": "Throughput observed at the storage object.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BasePhysicalPort": { "title": "Storage:Base Physical Port", "description": "Common attributes for a physical port in a storage array.", "x-allOf-name": "storage.BasePhysicalPort", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BasePhysicalPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiPort", "storage.NetAppFcInterface", "storage.NetAppFcPort", "storage.PurePort" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiPort", "storage.NetAppFcInterface", "storage.NetAppFcPort", "storage.PurePort" ], "x-enum-as-string": true }, "Iqn": { "description": "ISCSI qualified name applicable for ethernet port. Example - 'iqn.2008-05.com.storage:fnm00151300643-514f0c50141faf05'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the physical port available in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "Speed": { "description": "Operational speed of physical port measured in Gbps.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of storage array port.\n* `Unknown` - Component status is not available.\n* `Ok` - Component is healthy and no issues found.\n* `Degraded` - Functioning, but not at full capability due to a non-fatal failure.\n* `Critical` - Not functioning or requiring immediate attention.\n* `Offline` - Component is installed, but powered off.\n* `Identifying` - Component is in initialization process.\n* `NotAvailable` - Component is not installed or not available.\n* `Updating` - Software update is in progress.\n* `Unrecognized` - Component is not recognized. It may be because the component is not installed properly or it is not supported.", "type": "string", "enum": [ "Unknown", "Ok", "Degraded", "Critical", "Offline", "Identifying", "NotAvailable", "Updating", "Unrecognized" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Port type - possible values are FC, FCoE and iSCSI.\n* `FC` - Port supports fibre channel protocol.\n* `iSCSI` - Port supports iSCSI protocol.\n* `FCoE` - Port supports fibre channel over ethernet protocol.", "type": "string", "enum": [ "FC", "iSCSI", "FCoE" ], "default": "FC", "readOnly": true, "x-omitempty": true }, "Wwn": { "description": "World wide name of FC port. It is a combination of WWNN and WWPN represented in 128 bit hexadecimal formatted with colon.\nExample: '51:4f:0c:50:14:1f:af:01:51:4f:0c:51:14:1f:af:01'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Wwnn": { "description": "World wide node name of FC port. Represented in 64 bit hex digits, formatted with colon. Example - '51:4f:0c:50:14:1f:af:01'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Wwpn": { "description": "World wide port name of FC port. Represented in 64 bit hex digits, formatted with colon. Example - '51:4f:0c:51:14:1f:af:01'.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseProtectionGroup": { "title": "Storage:Base Protection Group", "description": "A protection group contains list of members that are protected together through snapshots with point-in-time consistency across the members.\nMembers within the protection group have common data protection requirements and also the same snapshot, replication, and retention schedules.", "x-allOf-name": "storage.BaseProtectionGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseProtectionGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureProtectionGroup" ], "default": "storage.PureProtectionGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureProtectionGroup" ], "default": "storage.PureProtectionGroup", "x-enum-as-string": true }, "Name": { "description": "Name of the protection Group.", "type": "string", "x-omitempty": true }, "Prefix": { "description": "Prefix used for all generated snapshots from the protection group.", "type": "string", "x-omitempty": true }, "ReplicationEnabled": { "description": "Flag to determine if replication is enabled. Snapshots are replicated to the target array if this flag is set.", "type": "boolean", "x-omitempty": true }, "SnapshotEnabled": { "description": "Flag to determine if snapshot creation is enabled. Snapshots are created on local array if this flag is set.", "type": "boolean", "x-omitempty": true } } } ] }, "storage.BaseProtectionGroupSnapshot": { "title": "Storage:Base Protection Group Snapshot", "description": "Protection group snapshot entity in protection group.", "x-allOf-name": "storage.BaseProtectionGroupSnapshot", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseProtectionGroupSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureProtectionGroupSnapshot" ], "default": "storage.PureProtectionGroupSnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureProtectionGroupSnapshot" ], "default": "storage.PureProtectionGroupSnapshot", "x-enum-as-string": true }, "CreatedTime": { "description": "Protection group snapshot creation time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Protection group snapshot name which represents point-in-time copy of all members in protection group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "Snapshot size represented in bytes. It is a cumulative size of all snapshots in a set.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Source": { "description": "Source protection group name on which the snapshot is created.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseRaidGroup": { "title": "Storage:Base Raid Group", "description": "A RAID group unifies a number of physical disks into one logical unit and distributes data across those disks.\nRAID groups can be configured with a particular protection level depending on the performance, capacity,\nand redundancy needs of the environment.", "x-allOf-name": "storage.BaseRaidGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseRaidGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiParityGroup" ], "default": "storage.HitachiParityGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.HitachiParityGroup" ], "default": "storage.HitachiParityGroup", "x-enum-as-string": true }, "Level": { "description": "The RAID level associated with the group of disks.\n* `Unknown` - Default unknown RAID type.\n* `RAID0` - RAID0 splits (\"stripes\") data evenly across two or more disks, without parity information.\n* `RAID1` - RAID1 requires a minimum of two disks to work, and provides data redundancy and failover.\n* `RAID4` - RAID4 stripes block level data and dedicates a disk to parity.\n* `RAID5` - RAID5 distributes striping and parity at a block level.\n* `RAID6` - RAID6 level operates like RAID5 with distributed parity and striping.\n* `RAID10` - RAID10 requires a minimum of four disks in the array. It stripes across disks for higher performance, and mirrors for redundancy.\n* `RAIDDP` - RAIDDP uses up to two spare disks to replace and reconstruct the data from up to two simultaneously failed disks within the RAID group.\n* `RAIDTEC` - With RAIDTEC protection, use up to three spare disks to replace and reconstruct the data from up to three simultaneously failed disks within the RAID group.", "type": "string", "enum": [ "Unknown", "RAID0", "RAID1", "RAID4", "RAID5", "RAID6", "RAID10", "RAIDDP", "RAIDTEC" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Human readable name of the RAID group.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of the RAID group in a storage array.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseReplicationBlackout": { "title": "Storage:Base Replication Blackout", "description": "The range of time during which replication will be suspended. System disables replication during this interval.", "x-allOf-name": "storage.BaseReplicationBlackout", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseReplicationBlackout', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureReplicationBlackout" ], "default": "storage.PureReplicationBlackout", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureReplicationBlackout" ], "default": "storage.PureReplicationBlackout", "x-enum-as-string": true }, "End": { "description": "The end time of day for replication blackout window.\nExample: 17:00:01 which is 17 hours, 0 minutes, 1 seconds.", "type": "string", "format": "time", "readOnly": true, "x-omitempty": true }, "Start": { "description": "The start time of day when replication blackout is active. When replication blackout is active, the storage array temporarily disables replication.\nExample: 15:04:03.123 which is 15 hours, 4 minutes, 3 seconds and 123 milliseconds.\nThe fractional seconds are written using the standard decimal notation which can be used for setting milliseconds and microseconds.", "type": "string", "format": "time", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseReplicationSchedule": { "title": "Storage:Base Replication Schedule", "description": "Configuration parameters for snapshot creation on target arrays.", "x-allOf-name": "storage.BaseReplicationSchedule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseReplicationSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureReplicationSchedule" ], "default": "storage.PureReplicationSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureReplicationSchedule" ], "default": "storage.PureReplicationSchedule", "x-enum-as-string": true }, "Frequency": { "description": "Replication frequency. It is an interval at which replication is set to trigger.\nExamples:\n PT2H, Snapshot is generated every 2 hours.\n P30D, Snapshot is scheduled for every 30 days.\n PT2H34M56.123S is 2 hours, 34 minutes, 56 seconds and 123 milliseconds.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Replication schedule name.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationTime": { "description": "Preferred time of day at which to replicate the snapshots on target array.\nIt is applicable only if the replication frequency is set for a day or more.\nFormat: hh:mm:ss\nExample: 15:00:00, Replication is set for 3:00 PM.", "type": "string", "format": "time", "readOnly": true, "x-omitempty": true }, "RetentionTime": { "description": "Duration to keep the replicated snapshots on the targets.\nReplicated snapshots are deleted from target array once the retention period has elapsed.\nExamples:\nP30D, Snapshots are available for 30 days.\nPT2H34M56.123S, 2 hours, 34 minutes, 56 seconds and 123 milliseconds.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseSnapshot": { "title": "Storage:Base Snapshot", "description": "Reference marker for volume. It is a point-in-time copy of the volume.", "x-allOf-name": "storage.BaseSnapshot", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppVolumeSnapshot", "storage.PureVolumeSnapshot" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppVolumeSnapshot", "storage.PureVolumeSnapshot" ], "x-enum-as-string": true }, "CreatedTime": { "description": "Exact date and time at which snapshot was created.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the snapshot which represents point-in-time copy of volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProtectionGroupName": { "description": "Name of the protection group to which the snapshot belongs. Value is empty, if the snapshot is created directly on volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "Snapshot size represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Source": { "description": "Source object on which the snapshot is created. It is the name of the originating volume.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseSnapshotSchedule": { "title": "Storage:Base Snapshot Schedule", "description": "Configuration parameters for snapshot creation at source array.", "x-allOf-name": "storage.BaseSnapshotSchedule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseSnapshotSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureSnapshotSchedule" ], "default": "storage.PureSnapshotSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureSnapshotSchedule" ], "default": "storage.PureSnapshotSchedule", "x-enum-as-string": true }, "Frequency": { "description": "Snapshot frequency. It is an interval at which snapshot is set to trigger on source array.\nExamples:\n PT2H Snapshot is generated every 2 hours.\n P4D, Snapshot is scheduled for every 4 days.\n PT2H34M56.123S is 2 hours, 34 minutes, 56 seconds and 123 milliseconds.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the snapshot schedule.", "type": "string", "x-omitempty": true }, "RetentionTime": { "description": "Duration to keep the snapshots on the source array.\nOnce this period expires, system deletes the snapshot automatically from the source array.\nExamples:\nP200D, 200 days.\nPT2H34M56.123S, 2 hours, 34 minutes, 56 seconds and 123 milliseconds.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotTime": { "description": "Preferred time of the day to capture the snapshot. It is applicable only if the frequency is set for a day or more.\nFormat: hh:mm:ss\nExample: 08:30:00, Snapshot is set for 08:30 AM.", "type": "string", "format": "time", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseStorageContainer": { "title": "Storage:Base Storage Container", "description": "Storage container objects. It is a logical entity having common attributes of storage pool/datastores.", "x-allOf-name": "storage.BaseStorageContainer", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseStorageContainer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.StorageContainer", "storage.HyperFlexStorageContainer", "storage.NetAppVolume" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.StorageContainer", "storage.HyperFlexStorageContainer", "storage.NetAppVolume" ], "x-enum-as-string": true }, "CreatedTime": { "description": "Storage container's creation time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the storage container.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization information of storage container.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseTarget": { "title": "Storage:Base Target", "description": "Generic representation for a Target. It is an entity that provides storage block access to host.", "x-allOf-name": "storage.BaseTarget", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Target" ], "default": "hyperflex.Target", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Target" ], "default": "hyperflex.Target", "x-enum-as-string": true }, "Description": { "description": "Short description about the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the target in storage array.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseTenant": { "title": "Storage:Base Tenant", "description": "Generic tenant object which represents a logical storage system within a physical storage array.", "x-allOf-name": "storage.BaseTenant", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseTenant', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppStorageVm" ], "default": "storage.NetAppStorageVm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppStorageVm" ], "default": "storage.NetAppStorageVm", "x-enum-as-string": true }, "Name": { "description": "Name of the tenant in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of this tenant.\n* `Unknown` - Component state is not available.\n* `Starting` - Component is being started.\n* `Running` - Component is currently running.\n* `Stopping` - Component is being stopped.\n* `Stopped` - Component has been stopped.\n* `Deleting` - Component deletion is in progress.", "type": "string", "enum": [ "Unknown", "Starting", "Running", "Stopping", "Stopped", "Deleting" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The uuid of this tenant in storage array.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BaseVolume.Relationship": { "description": "A relationship to the 'storage.BaseVolume' resource, or the expanded 'storage.BaseVolume' resource, or the 'null' value.", "x-one-of-name": "storage.BaseVolume.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.BaseVolume" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.BaseVolume": { "title": "Storage:Base Volume", "description": "Generic storage volume object. It is a provisioned storage identity which can be mapped to host to enable host access.", "x-allOf-name": "storage.BaseVolume", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BaseVolume', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Volume", "storage.HitachiVolume", "storage.HyperFlexVolume", "storage.NetAppLun", "storage.PureVolume" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "hyperflex.Volume", "storage.HitachiVolume", "storage.HyperFlexVolume", "storage.NetAppLun", "storage.PureVolume" ], "x-enum-as-string": true }, "Description": { "description": "Short description about the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "NaaId": { "description": "NAA id of volume. It is a significant number to identify corresponding lun path in hypervisor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Named entity of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "User provisioned volume size. It is the size exposed to host.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of volume entity in storage array.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true } } } ] }, "storage.BatteryBackupUnit.Response": { "description": "The response body of a HTTP GET request for the 'storage.BatteryBackupUnit' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.BatteryBackupUnit' resources.", "x-one-of-name": "storage.BatteryBackupUnit.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.BatteryBackupUnit.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.BatteryBackupUnit.Relationship": { "description": "A relationship to the 'storage.BatteryBackupUnit' resource, or the expanded 'storage.BatteryBackupUnit' resource, or the 'null' value.", "x-one-of-name": "storage.BatteryBackupUnit.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.BatteryBackupUnit" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.BatteryBackupUnit": { "title": "Storage:Battery Backup Unit", "description": "Information of Battery Backup Unit in the storage controller.", "x-allOf-name": "storage.BatteryBackupUnit", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.BatteryBackupUnit', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.BatteryBackupUnit" ], "default": "storage.BatteryBackupUnit", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.BatteryBackupUnit" ], "default": "storage.BatteryBackupUnit", "x-enum-as-string": true }, "CapacitanceInPercent": { "description": "This holds the capacitance (in percent) of the battery backup unit of the storage controller.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ChargingState": { "description": "This holds the charging state of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "CurrentInAmps": { "description": "This holds the current (in Amps) of the battery backup unit of the storage controller.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DesignCapacityInJoules": { "description": "This holds the design Capacity (in joules) of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "DesignVoltageInVolts": { "description": "This holds the design volatage (in Volts) of the battery backup unit of the storage controller.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DeviceName": { "description": "This refers to the device name of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsBatteryPresent": { "description": "This indicates whether the battery is present for the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCapacitor": { "description": "This indicates the capacitor for the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsLearnCycleRequested": { "description": "This indicates learn cycle request of the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsLearnCycleTransparent": { "description": "This indicates the learn cycle transparent for the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsTemperatureHigh": { "description": "This indicates the temperature is high for the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsVoltageLow": { "description": "This indicates the voltage is Low for the battery backup unit of the storage controller.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LearnCycleProgressEndTimeStamp": { "description": "This refers to learn cycle progress end time of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "LearnCycleProgressStartTimeStamp": { "description": "This refers to learn cycle progress start time of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "LearnCycleProgressStatus": { "description": "This refers to learn cycle progress status of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "LearnMode": { "description": "This refers to the learn mode of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManufacturingDate": { "description": "This refers to the manufacture date of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ModuleVersion": { "description": "This refers to the current module version of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "NextLearnCycleTimeStamp": { "description": "This refers to next learn cycle timestamp of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "PackEnergyInJoules": { "description": "This holds the pack energy (in joules) of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "RemainingPoolSpaceInPercent": { "description": "This holds the remaining pool space (in percent) of the battery backup unit of the storage controller.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "This holds the current status of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "TemperatureInCel": { "description": "This holds the temperature (in Celsius) of the battery backup unit of the storage controller.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Type": { "description": "This refers to the type of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "VoltageInVolts": { "description": "This holds the volatage (in Volts) of the battery backup unit of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.BatteryBackupUnit.List": { "title": "List of 'storage.BatteryBackupUnit' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.BatteryBackupUnit' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.BatteryBackupUnit' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.BatteryBackupUnit" }, "nullable": true } } } ] }, "storage.Controller.Response": { "description": "The response body of a HTTP GET request for the 'storage.Controller' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.Controller' resources.", "x-one-of-name": "storage.Controller.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.Controller.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.Controller.Relationship": { "description": "A relationship to the 'storage.Controller' resource, or the expanded 'storage.Controller' resource, or the 'null' value.", "x-one-of-name": "storage.Controller.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.Controller" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.Controller": { "title": "Storage:Controller", "description": "Storage Controller present in a server.", "x-allOf-name": "storage.Controller", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Controller', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Controller" ], "default": "storage.Controller", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Controller" ], "default": "storage.Controller", "x-enum-as-string": true }, "ConnectedSasExpander": { "description": "Storage controller is connected to SAS expander.", "type": "boolean", "x-omitempty": true }, "ControllerFlags": { "description": "The flags for the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerId": { "description": "The Id of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerStatus": { "description": "The current status of controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "DefaultDriveMode": { "description": "Auto configuration mode for the newly inserted physical drives.", "type": "string", "x-omitempty": true }, "EccBucketLeakRate": { "description": "The ECC bucket leak rate for the Storage Controller in minutes.", "type": "integer", "format": "int64", "x-omitempty": true }, "ForeignConfigPresent": { "description": "Storage controller has detected disks in foreign config.", "type": "boolean", "x-omitempty": true }, "HwRevision": { "description": "The hardware revision of controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "HybridSlotsSupported": { "description": "U.3 Hybrid Slot Support of the Storage Controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceType": { "description": "Interface types are Sas, Sata, PCH.", "type": "string", "x-omitempty": true }, "MaxVolumesSupported": { "description": "Maximum virtual drives that can be created on this Storage Controller.", "type": "integer", "format": "int64", "x-omitempty": true }, "MemoryCorrectableErrors": { "description": "The number of memory correctable errors reported by the Storage Controller.", "type": "integer", "format": "int64", "x-omitempty": true }, "Name": { "description": "Name of the Storage Controller.", "type": "string", "x-omitempty": true }, "OobInterfaceSupported": { "description": "The CIMC support for out-of-band configuration of controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the controller.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The current operational state of controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "Operability state of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciAddr": { "description": "The current pci address of controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "PciSlot": { "description": "The pci slot name for the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "PersistentCacheSize": { "description": "The portion of the cache memory that is persistent, measured in MiB.", "type": "integer", "format": "int64", "x-omitempty": true }, "PinnedCacheState": { "description": "The pinned cache state of the Storage Controller.", "type": "integer", "format": "int64", "x-omitempty": true }, "RaidSupport": { "description": "The RAID levels supported by controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "RebuildRate": { "description": "Logical volume or RAID rebuild rate of Storage Controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "RebuildRatePercent": { "description": "Logical volume or RAID rebuild rate of Storage Controller.", "type": "integer", "format": "int64", "x-omitempty": true }, "SelfEncryptEnabled": { "description": "Storage controller disk self encryption state.", "type": "string", "x-omitempty": true }, "SubOemId": { "description": "The Sub OEM identifier of the Storage Controller.", "type": "string", "x-omitempty": true }, "SupportedStripSizes": { "description": "The strip sizes in KiB supported by the Storage Controller.", "type": "string", "x-omitempty": true }, "TotalCacheSize": { "description": "The total configured cache memory, measured in MiB.", "type": "integer", "format": "int64", "x-omitempty": true }, "Type": { "description": "Controller types are Raid, FlexFlash.", "type": "string", "readOnly": true, "x-omitempty": true }, "BackupBatteryUnit": { "$ref": "#/components/schemas/storage.BatteryBackupUnit.Relationship", "description": "A reference to a storageBatteryBackupUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "DiskGroup": { "description": "An array of relationships to storageDiskGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DiskGroup.Relationship" }, "nullable": true }, "DiskSlot": { "description": "An array of relationships to storageDiskSlot resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DiskSlot.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDiskExtensions": { "description": "An array of relationships to storagePhysicalDiskExtension resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension.Relationship" }, "nullable": true, "readOnly": true }, "PhysicalDisks": { "description": "An array of relationships to storagePhysicalDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "VirtualDriveExtensions": { "description": "An array of relationships to storageVirtualDriveExtension resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDriveExtension.Relationship" }, "nullable": true, "readOnly": true }, "VirtualDrives": { "description": "An array of relationships to storageVirtualDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.Controller.List": { "title": "List of 'storage.Controller' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.Controller' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.Controller' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Controller" }, "nullable": true } } } ] }, "storage.ControllerDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.ControllerDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.ControllerDrive' resources.", "x-one-of-name": "storage.ControllerDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.ControllerDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.ControllerDrive.Relationship": { "description": "A relationship to the 'storage.ControllerDrive' resource, or the expanded 'storage.ControllerDrive' resource, or the 'null' value.", "x-one-of-name": "storage.ControllerDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.ControllerDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.ControllerDrive": { "title": "Storage:Controller Drive", "description": "The equipment.ChassisController object represents the controller embedded within a network element that is responsible for managing a chassis. It is particularly relevant in architectures like UCS X-Series Direct, where the Fabric Interconnects directly manage the chassis.\n#### Purpose\nThe primary function of this object is to inventory the existence and state of the chassis management controller function within a network element. It reports on its health and equipment type (e.g., ECMC for an X-Series chassis), providing visibility into the component responsible for chassis-level management tasks.\n#### Key Concepts\n- **Management Function Inventory:** Models the logical chassis controller as a distinct entity within a network element.\n- **Health Reporting:** The operReason property provides details on any health issues affecting the controller's operation.\n- **Type Identification:** The equipmentType property specifies the kind of chassis controller, which can inform management logic.\n- **Network Element Association:** It is a child of a network.Element, clearly linking the chassis management function to the physical switch that hosts it.", "x-allOf-name": "storage.ControllerDrive", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.ControllerDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.ControllerDrive" ], "default": "storage.ControllerDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.ControllerDrive" ], "default": "storage.ControllerDrive", "x-enum-as-string": true }, "ControllerType": { "description": "The type of Local Storage like FlexMMC, USB Drive.\n* `Unknown` - Storage partition type is not known.\n* `FlexMMC` - The FlexMMC type of storage local drive.\n* `USB` - The USB type of storage drive.", "type": "string", "enum": [ "Unknown", "FlexMMC", "USB" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Description": { "description": "The description of local storage drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the local Storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartitionCount": { "description": "Total Partition count in local storage.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageId": { "description": "The Id of the local Storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of storage like internal or external.\n* `Unknown` - Not any of the known Storage Types.\n* `Internal` - The internal storage type.\n* `External` - The external storage type.", "type": "string", "enum": [ "Unknown", "Internal", "External" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageItem": { "description": "An array of relationships to storageItem resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Item.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.ControllerDrive.List": { "title": "List of 'storage.ControllerDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.ControllerDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.ControllerDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.ControllerDrive" }, "nullable": true } } } ] }, "storage.DiskGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.DiskGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.DiskGroup' resources.", "x-one-of-name": "storage.DiskGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.DiskGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.DiskGroup.Relationship": { "description": "A relationship to the 'storage.DiskGroup' resource, or the expanded 'storage.DiskGroup' resource, or the 'null' value.", "x-one-of-name": "storage.DiskGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.DiskGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.DiskGroup": { "title": "Storage:Disk Group", "description": "Group of one or more Spans to configure virtual drive.", "x-allOf-name": "storage.DiskGroup", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.DiskGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.DiskGroup" ], "default": "storage.DiskGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.DiskGroup" ], "default": "storage.DiskGroup", "x-enum-as-string": true }, "Name": { "description": "Name to identity this disk group in the controller.", "type": "string", "x-omitempty": true }, "RaidType": { "description": "Raid level of the virtual drives in this diskgroup.", "type": "string", "x-omitempty": true }, "DedicatedHotSpares": { "description": "An array of relationships to storagePhysicalDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Spans": { "description": "An array of relationships to storageSpan resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Span.Relationship" }, "nullable": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "VirtualDrives": { "description": "An array of relationships to storageVirtualDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship" }, "nullable": true } } } ] }, "storage.DiskGroup.List": { "title": "List of 'storage.DiskGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.DiskGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.DiskGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DiskGroup" }, "nullable": true } } } ] }, "storage.DiskSlot.Response": { "description": "The response body of a HTTP GET request for the 'storage.DiskSlot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.DiskSlot' resources.", "x-one-of-name": "storage.DiskSlot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.DiskSlot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.DiskSlot.Relationship": { "description": "A relationship to the 'storage.DiskSlot' resource, or the expanded 'storage.DiskSlot' resource, or the 'null' value.", "x-one-of-name": "storage.DiskSlot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.DiskSlot" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.DiskSlot": { "title": "Storage:Disk Slot", "description": "Information of disk slots as reported by a storage controller.", "x-allOf-name": "storage.DiskSlot", "allOf": [ { "$ref": "#/components/schemas/equipment.Slot" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.DiskSlot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.DiskSlot" ], "default": "storage.DiskSlot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.DiskSlot" ], "default": "storage.DiskSlot", "x-enum-as-string": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.DiskSlot.List": { "title": "List of 'storage.DiskSlot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.DiskSlot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.DiskSlot' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DiskSlot" }, "nullable": true } } } ] }, "storage.DriveGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.DriveGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.DriveGroup' resources.", "x-one-of-name": "storage.DriveGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.DriveGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.DriveGroup.Relationship": { "description": "A relationship to the 'storage.DriveGroup' resource, or the expanded 'storage.DriveGroup' resource, or the 'null' value.", "x-one-of-name": "storage.DriveGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.DriveGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.DriveGroup": { "title": "Drive Group", "description": "The DriveGroup object specifies a pool of drives and a set of virtual drives to be created using this pool, enabling flexible RAID configurations.\n#### Purpose\nThe DriveGroup object provides detailed configuration for RAID drive groups, supporting both manual and automatic drive selection. It optimizes drive utilization by organizing drives into efficient RAID setups and offers flexible configuration options through user-defined drive selections.\n#### Key Concepts\n- **RAID Level Support:** Configures RAID levels to match storage requirements and optimize data protection.\n- **Security Features:** Includes options for enabling drive security through manual or remote key management.", "x-allOf-name": "storage.DriveGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.DriveGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.DriveGroup" ], "default": "storage.DriveGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.DriveGroup" ], "default": "storage.DriveGroup", "x-enum-as-string": true }, "AutomaticDriveGroup": { "description": "This drive group is created using automatic drive selection.", "$ref": "#/components/schemas/storage.AutomaticDriveGroup", "x-omitempty": true }, "ManualDriveGroup": { "description": "This drive group is created by specifying the drive slots to be used.", "$ref": "#/components/schemas/storage.ManualDriveGroup", "x-omitempty": true }, "Name": { "description": "The name of the drive group. The name can be between 1 and 64 alphanumeric characters. Spaces or any special characters other than - (hyphen), _ (underscore), : (colon), and . (period) are not allowed.", "type": "string", "pattern": "^[a-zA-Z0-9_.:-]{1,64}$", "x-createOnly": true, "x-omitempty": true }, "RaidLevel": { "description": "The supported RAID level for the disk group.\n* `Raid0` - RAID 0 Stripe Raid Level.\n* `Raid1` - RAID 1 Mirror Raid Level.\n* `Raid5` - RAID 5 Mirror Raid Level.\n* `Raid6` - RAID 6 Mirror Raid Level.\n* `Raid10` - RAID 10 Mirror Raid Level.\n* `Raid50` - RAID 50 Mirror Raid Level.\n* `Raid60` - RAID 60 Mirror Raid Level.", "type": "string", "enum": [ "Raid0", "Raid1", "Raid5", "Raid6", "Raid10", "Raid50", "Raid60" ], "default": "Raid0", "x-omitempty": true }, "SecureDriveGroup": { "description": "Enables/disables the drive security on all the drives used in this policy. This flag just enables the drive security and only after Remote/Manual key setting configured, the actual security will be applied.", "type": "boolean", "x-omitempty": true }, "Type": { "description": "Type of drive selection to be used for this drive group.\n* `0` - Drives are selected manually by the user.\n* `1` - Drives are selected automatically based on the RAID and virtual drive configuration.", "type": "integer", "enum": [ 0, 1 ], "default": 0, "readOnly": true, "x-omitempty": true }, "VirtualDrives": { "type": "array", "items": { "description": "The list of virtual drives and the disk groups that need to be created through this policy.", "$ref": "#/components/schemas/storage.VirtualDriveConfiguration", "x-omitempty": true }, "nullable": true }, "StoragePolicy": { "$ref": "#/components/schemas/storage.StoragePolicy.Relationship", "description": "A reference to a storageStoragePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.DriveGroup.List": { "title": "List of 'storage.DriveGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.DriveGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.DriveGroup' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DriveGroup" }, "nullable": true } } } ] }, "storage.DriveSecurityPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.DriveSecurityPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.DriveSecurityPolicy' resources.", "x-one-of-name": "storage.DriveSecurityPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.DriveSecurityPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.DriveSecurityPolicy": { "title": "DriveSecurity", "description": "The DriveSecurityPolicy object defines configurations for manual keys or KMIP servers, ensuring drive security across multiple servers. It enables the implementation of encryption and security policies for storage drives.\n#### Purpose\nThe DriveSecurityPolicy object provides a comprehensive framework for managing drive security, supporting both manual and remote key management. It enhances security through drive encryption using manual or KMIP key configurations and ensures consistent application of security policies across server environments.\n#### Key Concepts\n- **Flexible Key Management:** Supports both manual and KMIP configurations, providing options for local and remote drive security.\n- **Integration with Profiles:** Can be linked with server profiles for streamlined security policy deployment.\n- **Read-Write Access:** Ensures configurable security settings can be adjusted to meet specific organizational requirements.", "x-allOf-name": "storage.DriveSecurityPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.DriveSecurityPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.DriveSecurityPolicy" ], "default": "storage.DriveSecurityPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.DriveSecurityPolicy" ], "default": "storage.DriveSecurityPolicy", "x-enum-as-string": true }, "KeySetting": { "description": "Key details for supporting drive security.", "$ref": "#/components/schemas/storage.KeySetting", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "storage.DriveSecurityPolicy.List": { "title": "List of 'storage.DriveSecurityPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.DriveSecurityPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.DriveSecurityPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DriveSecurityPolicy" }, "nullable": true } } } ] }, "storage.Enclosure.Response": { "description": "The response body of a HTTP GET request for the 'storage.Enclosure' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.Enclosure' resources.", "x-one-of-name": "storage.Enclosure.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.Enclosure.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.Enclosure.Relationship": { "description": "A relationship to the 'storage.Enclosure' resource, or the expanded 'storage.Enclosure' resource, or the 'null' value.", "x-one-of-name": "storage.Enclosure.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.Enclosure" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.Enclosure": { "title": "Storage:Enclosure", "description": "Storage Enclosure for physical disks.", "x-allOf-name": "storage.Enclosure", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Enclosure', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Enclosure" ], "default": "storage.Enclosure", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Enclosure" ], "default": "storage.Enclosure", "x-enum-as-string": true }, "ChassisId": { "description": "This represent the chassis-ID that houses the storage enclosure.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This represnets the description for the storage enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "EnclosureId": { "description": "This represnets the Identifier for the storage enclosure.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NumSlots": { "description": "This represent the number of slots present in storage enclosure.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ServerId": { "description": "This represent the server-ID that houses the storage enclosure.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Type": { "description": "This represent the type of storage enclosure.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBlade": { "$ref": "#/components/schemas/compute.Blade.Relationship", "description": "A reference to a computeBlade resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EnclosureDiskSlots": { "description": "An array of relationships to storageEnclosureDiskSlotEp resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp.Relationship" }, "nullable": true, "readOnly": true }, "EnclosureDisks": { "description": "An array of relationships to storageEnclosureDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.EnclosureDisk.Relationship" }, "nullable": true, "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDisks": { "description": "An array of relationships to storagePhysicalDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.Enclosure.List": { "title": "List of 'storage.Enclosure' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.Enclosure' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.Enclosure' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Enclosure" }, "nullable": true } } } ] }, "storage.EnclosureDisk.Response": { "description": "The response body of a HTTP GET request for the 'storage.EnclosureDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.EnclosureDisk' resources.", "x-one-of-name": "storage.EnclosureDisk.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.EnclosureDisk.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.EnclosureDisk.Relationship": { "description": "A relationship to the 'storage.EnclosureDisk' resource, or the expanded 'storage.EnclosureDisk' resource, or the 'null' value.", "x-one-of-name": "storage.EnclosureDisk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.EnclosureDisk" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.EnclosureDisk": { "title": "Storage:Enclosure Disk", "description": "Physical Disk on the enclosure.", "x-allOf-name": "storage.EnclosureDisk", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.EnclosureDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.EnclosureDisk" ], "default": "storage.EnclosureDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.EnclosureDisk" ], "default": "storage.EnclosureDisk", "x-enum-as-string": true }, "BlockSize": { "description": "The block size of the physical disk in bytes.", "type": "string", "x-omitempty": true }, "DiskId": { "description": "This field represents the disk Id in the storage enclosure.", "type": "string", "x-omitempty": true }, "DiskState": { "description": "This field identifies the current disk configuration applied in the physical disk.", "type": "string", "x-omitempty": true }, "Health": { "description": "The current health state of the enclosure disk.", "type": "string", "x-omitempty": true }, "NumBlocks": { "description": "The number of blocks present on the physical disk.", "type": "string", "x-omitempty": true }, "Pid": { "description": "This field identifies the Product ID for physicalDisk.", "type": "string", "readOnly": true, "x-omitempty": true }, "SasAddress1": { "description": "This field identifies the SAS address assigned to the disk SAS port-1.", "type": "string", "x-omitempty": true }, "SasAddress2": { "description": "This field identifies the SAS address assigned to the disk SAS port-2.", "type": "string", "x-omitempty": true }, "Size": { "description": "The size of the physical disk in MB.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageEnclosure": { "$ref": "#/components/schemas/storage.Enclosure.Relationship", "description": "A reference to a storageEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.EnclosureDisk.List": { "title": "List of 'storage.EnclosureDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.EnclosureDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.EnclosureDisk' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.EnclosureDisk" }, "nullable": true } } } ] }, "storage.EnclosureDiskSlotEp.Response": { "description": "The response body of a HTTP GET request for the 'storage.EnclosureDiskSlotEp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.EnclosureDiskSlotEp' resources.", "x-one-of-name": "storage.EnclosureDiskSlotEp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.EnclosureDiskSlotEp.Relationship": { "description": "A relationship to the 'storage.EnclosureDiskSlotEp' resource, or the expanded 'storage.EnclosureDiskSlotEp' resource, or the 'null' value.", "x-one-of-name": "storage.EnclosureDiskSlotEp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.EnclosureDiskSlotEp": { "title": "Storage:Enclosure Disk Slot Ep", "description": "Physical Disk slots on the enclosure.", "x-allOf-name": "storage.EnclosureDiskSlotEp", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.EnclosureDiskSlotEp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.EnclosureDiskSlotEp" ], "default": "storage.EnclosureDiskSlotEp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.EnclosureDiskSlotEp" ], "default": "storage.EnclosureDiskSlotEp", "x-enum-as-string": true }, "DrivePath": { "description": "This field identifies the zoning configuration applied to this enclosure slot.", "type": "string", "x-omitempty": true }, "Health": { "description": "This field identifies the health of the disk inserted in the slot.", "type": "string", "x-omitempty": true }, "Presence": { "description": "This field identifies the disk is present in the enclosure slot.", "type": "string", "x-omitempty": true }, "Slot": { "description": "This field represents the slot Id in the storage enclosure.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageEnclosure": { "$ref": "#/components/schemas/storage.Enclosure.Relationship", "description": "A reference to a storageEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.EnclosureDiskSlotEp.List": { "title": "List of 'storage.EnclosureDiskSlotEp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.EnclosureDiskSlotEp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.EnclosureDiskSlotEp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.EnclosureDiskSlotEp" }, "nullable": true } } } ] }, "storage.ExternalLun": { "title": "Storage:External Lun", "description": "The following properties are restored for each LU on the external storage system.", "x-allOf-name": "storage.ExternalLun", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.ExternalLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.ExternalLun" ], "default": "storage.ExternalLun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.ExternalLun" ], "default": "storage.ExternalLun", "x-enum-as-string": true }, "ExternalLun": { "description": "LUN within the ports of the external storage system.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalWwn": { "description": "WWN of the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "PathStatus": { "description": "Status of the external path.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Port number of the local storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Priority": { "description": "Priority within the external path group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.ExternalParityGroup": { "title": "Storage:External Parity Group", "description": "The following properties are stored for each external parity group.", "x-allOf-name": "storage.ExternalParityGroup", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.ExternalParityGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.ExternalParityGroup" ], "default": "storage.ExternalParityGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.ExternalParityGroup" ], "default": "storage.ExternalParityGroup", "x-enum-as-string": true }, "CacheMode": { "description": "Cache mode. Either E (enabled) or D (disabled) is displayed.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalLuns": { "type": "array", "items": { "description": "The following properties are restored for each LU on the external storage system.", "$ref": "#/components/schemas/storage.ExternalLun", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExternalParityGroupId": { "description": "External parity group number.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalParityGroupStatus": { "description": "Status of the external parity group.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsDataDirectMapping": { "description": "Whether the data direct mapping attribute is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsInflowControlEnabled": { "description": "Inflow cache control. Either true (enabled) or false (disabled) is displayed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LoadBalanceMode": { "description": "The load balancing method for I-O operations for the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "MpBladeId": { "description": "The blade number of the MP blade assigned to the external parity group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PathMode": { "description": "Path mode of the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.ExternalPath": { "title": "Storage:External Path", "description": "The following properties are restored for each external path.", "x-allOf-name": "storage.ExternalPath", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.ExternalPath', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.ExternalPath" ], "default": "storage.ExternalPath", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.ExternalPath" ], "default": "storage.ExternalPath", "x-enum-as-string": true }, "BlockedPathMonitoring": { "description": "The time (in seconds) until the external parity group is blocked after all paths to the external parity group are disconnected.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalWwn": { "description": "WWN of the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "IoTimeOut": { "description": "The value (in seconds) set for the I/O time over for the external parity group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Port number of external path on the local storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "QueueDepth": { "description": "Number of Read-Write commands that can be queued to the external parity group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.FileItem.Response": { "description": "The response body of a HTTP GET request for the 'storage.FileItem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FileItem' resources.", "x-one-of-name": "storage.FileItem.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FileItem.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FileItem.Relationship": { "description": "A relationship to the 'storage.FileItem' resource, or the expanded 'storage.FileItem' resource, or the 'null' value.", "x-one-of-name": "storage.FileItem.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FileItem" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FileItem": { "title": "Storage:File Item", "description": "The local Storage Files present in a server.", "x-allOf-name": "storage.FileItem", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FileItem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FileItem" ], "default": "storage.FileItem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FileItem" ], "default": "storage.FileItem", "x-enum-as-string": true }, "Description": { "description": "Description of the local Storage File.", "type": "string", "readOnly": true, "x-omitempty": true }, "FileId": { "description": "The Id of the local Storage File.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HostVisible": { "description": "The mapping visibility of the local Storage File.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the local Storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "Total size of the local Storage File.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "File type like CSV, ISO image.", "type": "string", "readOnly": true, "x-omitempty": true }, "UpdateTime": { "description": "Timestamp to indicate the uploaded time for this file.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageItem": { "$ref": "#/components/schemas/storage.Item.Relationship", "description": "A reference to a storageItem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FileItem.List": { "title": "List of 'storage.FileItem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FileItem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FileItem' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FileItem" }, "nullable": true } } } ] }, "storage.FlexFlashController.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexFlashController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexFlashController' resources.", "x-one-of-name": "storage.FlexFlashController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexFlashController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexFlashController.Relationship": { "description": "A relationship to the 'storage.FlexFlashController' resource, or the expanded 'storage.FlexFlashController' resource, or the 'null' value.", "x-one-of-name": "storage.FlexFlashController.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexFlashController" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexFlashController": { "title": "Storage:Flex Flash Controller", "description": "Storage Flex Flash Controller.", "x-allOf-name": "storage.FlexFlashController", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexFlashController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexFlashController" ], "default": "storage.FlexFlashController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexFlashController" ], "default": "storage.FlexFlashController", "x-enum-as-string": true }, "ControllerState": { "description": "State of the Flex Flash Storage Controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "FfControllerId": { "description": "Identifier for the Flex Flash Storage Controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FlexFlashControllerProps": { "description": "An array of relationships to storageFlexFlashControllerProps resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps.Relationship" }, "nullable": true, "readOnly": true }, "FlexFlashPhysicalDrives": { "description": "An array of relationships to storageFlexFlashPhysicalDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive.Relationship" }, "nullable": true, "readOnly": true }, "FlexFlashVirtualDrives": { "description": "An array of relationships to storageFlexFlashVirtualDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.FlexFlashController.List": { "title": "List of 'storage.FlexFlashController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexFlashController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexFlashController' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashController" }, "nullable": true } } } ] }, "storage.FlexFlashControllerProps.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexFlashControllerProps' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexFlashControllerProps' resources.", "x-one-of-name": "storage.FlexFlashControllerProps.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexFlashControllerProps.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexFlashControllerProps.Relationship": { "description": "A relationship to the 'storage.FlexFlashControllerProps' resource, or the expanded 'storage.FlexFlashControllerProps' resource, or the 'null' value.", "x-one-of-name": "storage.FlexFlashControllerProps.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexFlashControllerProps": { "title": "Storage:Flex Flash Controller Props", "description": "Flex flash controller properties.", "x-allOf-name": "storage.FlexFlashControllerProps", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexFlashControllerProps', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexFlashControllerProps" ], "default": "storage.FlexFlashControllerProps", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexFlashControllerProps" ], "default": "storage.FlexFlashControllerProps", "x-enum-as-string": true }, "CardsManageable": { "description": "Manageable card on the flex flash controller.", "type": "string", "x-omitempty": true }, "ConfiguredMode": { "description": "Mode configured on the flex flash controller.", "type": "string", "x-omitempty": true }, "ControllerName": { "description": "The current name of the flex flash controller.", "type": "string", "x-omitempty": true }, "ControllerStatus": { "description": "The current status of the flex flash controller.", "type": "string", "x-omitempty": true }, "FwVersion": { "description": "Firmware version of the flex flash controller.", "type": "string", "x-omitempty": true }, "InternalState": { "description": "Internal state of the flex flash controller.", "type": "string", "x-omitempty": true }, "OperatingMode": { "description": "Operating mode of flex flash controller.", "type": "string", "x-omitempty": true }, "PhysicalDriveCount": { "description": "Number of connected physical drives to a specific Flex flash controller.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product name of the flex flash controller.", "type": "string", "x-omitempty": true }, "StartupFwVersion": { "description": "Startup firmware version of the Flex flash controller.", "type": "string", "x-omitempty": true }, "VirtualDriveCount": { "description": "Number of virtual drives for a specific Flex flash controller.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexFlashController": { "$ref": "#/components/schemas/storage.FlexFlashController.Relationship", "description": "A reference to a storageFlexFlashController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexFlashControllerProps.List": { "title": "List of 'storage.FlexFlashControllerProps' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexFlashControllerProps' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexFlashControllerProps' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashControllerProps" }, "nullable": true } } } ] }, "storage.FlexFlashPhysicalDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexFlashPhysicalDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexFlashPhysicalDrive' resources.", "x-one-of-name": "storage.FlexFlashPhysicalDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexFlashPhysicalDrive.Relationship": { "description": "A relationship to the 'storage.FlexFlashPhysicalDrive' resource, or the expanded 'storage.FlexFlashPhysicalDrive' resource, or the 'null' value.", "x-one-of-name": "storage.FlexFlashPhysicalDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexFlashPhysicalDrive": { "title": "Storage:Flex Flash Physical Drive", "description": "Physical Drive repersenting a SD Card.", "x-allOf-name": "storage.FlexFlashPhysicalDrive", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexFlashPhysicalDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexFlashPhysicalDrive" ], "default": "storage.FlexFlashPhysicalDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexFlashPhysicalDrive" ], "default": "storage.FlexFlashPhysicalDrive", "x-enum-as-string": true }, "CardStatus": { "description": "The status of the flex flash physical drive.", "type": "string", "x-omitempty": true }, "CardType": { "description": "The card type of the flex flash physical drive.", "type": "string", "x-omitempty": true }, "OemId": { "description": "The OEM Identifier of the flex flash physical drive.", "type": "string", "x-omitempty": true }, "PdStatus": { "description": "The drive status of the flex flash physical drive.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexFlashController": { "$ref": "#/components/schemas/storage.FlexFlashController.Relationship", "description": "A reference to a storageFlexFlashController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexFlashPhysicalDrive.List": { "title": "List of 'storage.FlexFlashPhysicalDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexFlashPhysicalDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexFlashPhysicalDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashPhysicalDrive" }, "nullable": true } } } ] }, "storage.FlexFlashVirtualDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexFlashVirtualDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexFlashVirtualDrive' resources.", "x-one-of-name": "storage.FlexFlashVirtualDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexFlashVirtualDrive.Relationship": { "description": "A relationship to the 'storage.FlexFlashVirtualDrive' resource, or the expanded 'storage.FlexFlashVirtualDrive' resource, or the 'null' value.", "x-one-of-name": "storage.FlexFlashVirtualDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexFlashVirtualDrive": { "title": "Storage:Flex Flash Virtual Drive", "description": "Virtual Drive repersenting a SD Card.", "x-allOf-name": "storage.FlexFlashVirtualDrive", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexFlashVirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexFlashVirtualDrive" ], "default": "storage.FlexFlashVirtualDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexFlashVirtualDrive" ], "default": "storage.FlexFlashVirtualDrive", "x-enum-as-string": true }, "DriveScope": { "description": "The drive scope of the flex flash virtual drive.", "type": "string", "x-omitempty": true }, "DriveStatus": { "description": "Status of virtual drive on the flex controller.", "type": "string", "x-omitempty": true }, "PartitionId": { "description": "The partition Id of the flex flash virtual Drive.", "type": "string", "x-omitempty": true }, "ResidentImage": { "description": "The resident image on the flex flash virtual Drive.", "type": "string", "x-omitempty": true }, "Size": { "description": "Size of virtual drive on the flex controller.", "type": "string", "x-omitempty": true }, "VirtualDrive": { "description": "Virtual drive on the flex flash controller.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexFlashController": { "$ref": "#/components/schemas/storage.FlexFlashController.Relationship", "description": "A reference to a storageFlexFlashController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexFlashVirtualDrive.List": { "title": "List of 'storage.FlexFlashVirtualDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexFlashVirtualDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexFlashVirtualDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexFlashVirtualDrive" }, "nullable": true } } } ] }, "storage.FlexUtilController.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexUtilController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexUtilController' resources.", "x-one-of-name": "storage.FlexUtilController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexUtilController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexUtilController.Relationship": { "description": "A relationship to the 'storage.FlexUtilController' resource, or the expanded 'storage.FlexUtilController' resource, or the 'null' value.", "x-one-of-name": "storage.FlexUtilController.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexUtilController" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexUtilController": { "title": "Storage:Flex Util Controller", "description": "Storage Flex Util Adapter.", "x-allOf-name": "storage.FlexUtilController", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexUtilController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexUtilController" ], "default": "storage.FlexUtilController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexUtilController" ], "default": "storage.FlexUtilController", "x-enum-as-string": true }, "ControllerName": { "description": "Name of the Flex Util Controller.", "type": "string", "x-omitempty": true }, "ControllerStatus": { "description": "The current status of the controller.", "type": "string", "x-omitempty": true }, "FfControllerId": { "description": "Identifier for the Storage Flex Util Controller.", "type": "string", "x-omitempty": true }, "InternalState": { "description": "The internal state of the controller.", "type": "string", "x-omitempty": true }, "ComputeBoard": { "$ref": "#/components/schemas/compute.Board.Relationship", "description": "A reference to a computeBoard resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FlexUtilPhysicalDrives": { "description": "An array of relationships to storageFlexUtilPhysicalDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive.Relationship" }, "nullable": true, "readOnly": true }, "FlexUtilVirtualDrives": { "description": "An array of relationships to storageFlexUtilVirtualDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive.Relationship" }, "nullable": true, "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexUtilController.List": { "title": "List of 'storage.FlexUtilController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexUtilController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexUtilController' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilController" }, "nullable": true } } } ] }, "storage.FlexUtilPhysicalDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexUtilPhysicalDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexUtilPhysicalDrive' resources.", "x-one-of-name": "storage.FlexUtilPhysicalDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexUtilPhysicalDrive.Relationship": { "description": "A relationship to the 'storage.FlexUtilPhysicalDrive' resource, or the expanded 'storage.FlexUtilPhysicalDrive' resource, or the 'null' value.", "x-one-of-name": "storage.FlexUtilPhysicalDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexUtilPhysicalDrive": { "title": "Storage:Flex Util Physical Drive", "description": "Storage Flex Util Physical Drive.", "x-allOf-name": "storage.FlexUtilPhysicalDrive", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexUtilPhysicalDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexUtilPhysicalDrive" ], "default": "storage.FlexUtilPhysicalDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexUtilPhysicalDrive" ], "default": "storage.FlexUtilPhysicalDrive", "x-enum-as-string": true }, "BlockSize": { "description": "Block size of the FlexUtil Physical drive.", "type": "string", "x-omitempty": true }, "Capacity": { "description": "Capacity of the FlexUtil Physical drive.", "type": "string", "x-omitempty": true }, "Controller": { "description": "Type of the Physical Drive Controller.", "type": "string", "x-omitempty": true }, "DrivesEnabled": { "description": "The number of drives enabled in the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "Health": { "description": "Health of the FlexUtil Physical drive.", "type": "string", "x-omitempty": true }, "ManufacturerDate": { "description": "Manufacturing date of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "ManufacturerId": { "description": "Manufacturer identity of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "OemId": { "description": "The OEM Identifier of the FlexUtil physical drive.", "type": "string", "x-omitempty": true }, "PartitionCount": { "description": "The number of partitions present on the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "PdStatus": { "description": "Status of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "PhysicalDrive": { "description": "The type of physical drive. Example - microSD.", "type": "string", "x-omitempty": true }, "ProductName": { "description": "Product name of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "ProductRevision": { "description": "Product revision of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "ReadErrorCount": { "description": "Read error count of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "ReadErrorThreshold": { "description": "Read error threshold for FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "WriteEnabled": { "description": "Write access state of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "WriteErrorCount": { "description": "Write error count of the FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "WriteErrorThreshold": { "description": "Write error threshold for FlexUtil Physical Drive.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexUtilController": { "$ref": "#/components/schemas/storage.FlexUtilController.Relationship", "description": "A reference to a storageFlexUtilController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexUtilPhysicalDrive.List": { "title": "List of 'storage.FlexUtilPhysicalDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexUtilPhysicalDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexUtilPhysicalDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilPhysicalDrive" }, "nullable": true } } } ] }, "storage.FlexUtilVirtualDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.FlexUtilVirtualDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.FlexUtilVirtualDrive' resources.", "x-one-of-name": "storage.FlexUtilVirtualDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.FlexUtilVirtualDrive.Relationship": { "description": "A relationship to the 'storage.FlexUtilVirtualDrive' resource, or the expanded 'storage.FlexUtilVirtualDrive' resource, or the 'null' value.", "x-one-of-name": "storage.FlexUtilVirtualDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.FlexUtilVirtualDrive": { "title": "Storage:Flex Util Virtual Drive", "description": "Storage Flex Util Virtual Drive.", "x-allOf-name": "storage.FlexUtilVirtualDrive", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.FlexUtilVirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.FlexUtilVirtualDrive" ], "default": "storage.FlexUtilVirtualDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.FlexUtilVirtualDrive" ], "default": "storage.FlexUtilVirtualDrive", "x-enum-as-string": true }, "DriveStatus": { "description": "Status of the Flex Util virtual drive.", "type": "string", "x-omitempty": true }, "DriveType": { "description": "Type of virtual drive managed by flex util controller.", "type": "string", "x-omitempty": true }, "HostAccessible": { "description": "Connection status of the Flex Util virtual drive to the host.", "type": "string", "x-omitempty": true }, "PartitionId": { "description": "Disk Partition Id of virtual drive managed by flex util controller.", "type": "string", "x-omitempty": true }, "PartitionName": { "description": "Partition name of the Flex Util virtual drive.", "type": "string", "x-omitempty": true }, "ResidentImage": { "description": "The resident image on the flex util virtual Drive.", "type": "string", "x-omitempty": true }, "Size": { "description": "Size of the Flex Util virtual drive.", "type": "string", "x-omitempty": true }, "VirtualDrive": { "description": "Virtual drive on the Flex Util controller.", "type": "string", "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFlexUtilController": { "$ref": "#/components/schemas/storage.FlexUtilController.Relationship", "description": "A reference to a storageFlexUtilController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.FlexUtilVirtualDrive.List": { "title": "List of 'storage.FlexUtilVirtualDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.FlexUtilVirtualDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.FlexUtilVirtualDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FlexUtilVirtualDrive" }, "nullable": true } } } ] }, "storage.HitachiArray.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiArray' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiArray' resources.", "x-one-of-name": "storage.HitachiArray.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiArray.Relationship": { "description": "A relationship to the 'storage.HitachiArray' resource, or the expanded 'storage.HitachiArray' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiArray.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiArray": { "title": "Storage:Hitachi Array", "description": "The HitachiArray object represents the comprehensive details of a Hitachi storage array within the system. It is designed to provide out-of-band configuration and management capabilities, enabling efficient management and diagnostics of storage arrays.\n#### Purpose\nThe HitachiArray object serves as a central entity for managing Hitachi storage arrays, encompassing functionalities that support performance data collection, configuration, and connection management.\n#### Key Concepts\n- **Device Registration:** Facilitates the connection of storage arrays to Intersight, ensuring seamless integration and management.\n- **IP Configuration:** Provides detailed IP address settings for service processors and controllers, supporting robust network configurations.\n- **Privilege Sets:** Ensures controlled access with defined privilege sets for reading and updating storage array configurations.\n- **Licensing and Entitlements:** Supports operations under specified entitlements, ensuring compliance and feature availability.", "x-allOf-name": "storage.HitachiArray", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArray" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiArray" ], "default": "storage.HitachiArray", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiArray" ], "default": "storage.HitachiArray", "x-enum-as-string": true }, "Ctl1Ip": { "description": "IP address of controller 1 of the storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ctl1MicroVersion": { "description": "GUM (Gateway for Unified Management) version of the controller 1.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ctl2Ip": { "description": "IP address of controller 2 of the storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ctl2MicroVersion": { "description": "GUM (Gateway for Unified Management) version of the controller 2.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeviceId": { "description": "ID of the Storage device.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ip": { "description": "The representative IP address (IPv4) of the storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvpIp": { "description": "IP address of the SVP (Service Processor). The SVP provides out-of-band configuration and management of the storage system, and collects performance data for key components to enable diagnostic testing and analysis.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetCtl": { "description": "Controller operated by the REST API.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiArray.List": { "title": "List of 'storage.HitachiArray' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiArray' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiArray' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray" }, "nullable": true } } } ] }, "storage.HitachiArrayUtilization": { "title": "Storage:Hitachi Array Utilization", "description": "Storage space consumption of Hitachi Virtual Storage.", "x-allOf-name": "storage.HitachiArrayUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiArrayUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiArrayUtilization" ], "default": "storage.HitachiArrayUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiArrayUtilization" ], "default": "storage.HitachiArrayUtilization", "x-enum-as-string": true }, "DataReduction": { "description": "Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5.0 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Provisioned": { "description": "Total provisioned storage capacity in Hitachi Virtual Storage, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.HitachiCapacity": { "title": "Storage:Hitachi Capacity", "description": "Storage space utilization of Hitachi Arrays. Used for specifying utilization by different entities.", "x-allOf-name": "storage.HitachiCapacity", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" } ] }, "storage.HitachiController.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiController' resources.", "x-one-of-name": "storage.HitachiController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiController": { "title": "Storage:Hitachi Controller", "description": "The HitachiController object represents a storage controller entity within a Hitachi storage array. It is essential for managing controller configurations and relationships, supporting effective storage system operations.\n#### Purpose\nHitachiController is crucial for managing controllers within Hitachi arrays. This provides insights into controller settings and relationships, facilitating streamlined storage system management.\n#### Key Concepts\n- **Controller Configuration:** Details settings and properties of storage controllers, supporting efficient management and monitoring.\n- **Device Registration:** Connects controllers to device registration objects, ensuring seamless integration within the Intersight system.\n- **Array Management:** Links controllers to storage arrays, supporting comprehensive system operations and resource allocation.\n- **Access Control:** Utilizes privilege sets to ensure secure and authorized operations on controllers.", "x-allOf-name": "storage.HitachiController", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayController" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiController" ], "default": "storage.HitachiController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiController" ], "default": "storage.HitachiController", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiController.List": { "title": "List of 'storage.HitachiController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiController' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiController" }, "nullable": true } } } ] }, "storage.HitachiDisk.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiDisk' resources.", "x-one-of-name": "storage.HitachiDisk.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiDisk.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiDisk": { "title": "Storage:Hitachi Disk", "description": "The HitachiDisk object represents a disk entity associated with a Hitachi storage array. This provides detailed information about disk types and configurations, supporting effective storage resource management.\n#### Purpose\nHitachiDisk is integral to managing disks within Hitachi arrays. It delivers insights into disk properties and usage, aiding in optimal storage allocation and monitoring.\n#### Key Concepts\n- **Disk Type and Configuration:** Details disk types and configurations, supporting comprehensive management of storage resources.\n- **Parity Group Association:** Links disks to parity groups, ensuring reliable data redundancy and protection.\n- **Device Registration:** Connects disks to device registration objects, facilitating seamless integration within the Intersight system.\n- **Access Control:** Utilizes privilege sets to ensure secure and authorized operations on disks.", "x-allOf-name": "storage.HitachiDisk", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayDisk" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiDisk" ], "default": "storage.HitachiDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiDisk" ], "default": "storage.HitachiDisk", "x-enum-as-string": true }, "DriveTypeCode": { "description": "Drive type code of the Hitachi Disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParityGroupId": { "description": "Parity group number. When the drive does not belong to any parity group, an empty character string is output.", "type": "string", "readOnly": true, "x-omitempty": true }, "TypeDetail": { "description": "Drive type of the Hitachi Disk.\n* `N/A` - Drive Type is not available.\n* `SAS` - SAS stands for Serial Attached SCSI.\n* `SSD(MLC)` - SSD (MLC) stands for Multiple Level Cell.\n* `SSD(FMC)` - SSD (FMC) stands for Flash Memory Compressed.\n* `SSD(FMD)` - SSD (FMD) stands for Flash Module Drive.\n* `SSD(SLC)` - SSD (SLC) stands for Single Level Cell.\n* `SSD` - SSD stands for Solid-State Drive.\n* `SSD(RI)` - SSD (RI) stands for Read Intensive.\n* `SCM` - SCM stands for Storage Class Memory.", "type": "string", "enum": [ "N/A", "SAS", "SSD(MLC)", "SSD(FMC)", "SSD(FMD)", "SSD(SLC)", "SSD", "SSD(RI)", "SCM" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "Usage": { "description": "Purpose for which the drive is used.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ParityGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup.Relationship", "description": "A reference to a storageHitachiParityGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiDisk.List": { "title": "List of 'storage.HitachiDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiDisk' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiDisk" }, "nullable": true } } } ] }, "storage.HitachiExternalParityGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiExternalParityGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiExternalParityGroup' resources.", "x-one-of-name": "storage.HitachiExternalParityGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalParityGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiExternalParityGroup": { "title": "Storage:Hitachi External Parity Group", "description": "The HitachiExternalParityGroup object defines an external parity group within the Hitachi storage array, encapsulating attributes related to external storage connections.\n#### Purpose\nHitachiExternalParityGroup serves as the foundational element for managing external parity groups, supporting operations related to capacity, utilization, and emulation settings.\n#### Key Concepts\n- **External Storage Management:** Manages usage rates, capacities, and emulation types for external parity groups.\n- **Privilege Sets:** Ensures secure management of external parity group settings with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized operations.", "x-allOf-name": "storage.HitachiExternalParityGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiExternalParityGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiExternalParityGroup" ], "default": "storage.HitachiExternalParityGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiExternalParityGroup" ], "default": "storage.HitachiExternalParityGroup", "x-enum-as-string": true }, "AllocatableOpenVolumeCapacity": { "description": "From among the open volumes in the external parity group, the total capacity of volumes to which paths can be allocated (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AllocatedOpenVolumeCapacity": { "description": "From among the open volumes in the external parity group, the total capacity of volumes to which paths are allocated (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AvailableVolumeCapacity": { "description": "Available capacity of the external parity group, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ClprId": { "description": "Number of CLPR to which the external parity group belongs.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EmulationType": { "description": "Emulation type of the external parity group.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalProductId": { "description": "Storage system that is connected using the external storage connection functionality of Universal Volume Manager.", "type": "string", "readOnly": true, "x-omitempty": true }, "LargestAvailableCapacity": { "description": "Maximum capacity of the non-volume areas in the external parity group (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "External parity group number.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReservedOpenVolumeCapacity": { "description": "From among the open volumes in the external parity group, the total capacity of volumes which are reserved (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Spaces": { "type": "array", "items": { "description": "Some attributes for the free space and the LDEV defined in the specified external parity group.", "$ref": "#/components/schemas/storage.Space", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StorageUtilization": { "description": "Storage utilization of the external parity group in a storage array.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiCapacity", "readOnly": true, "x-omitempty": true }, "TotalOpenVolumeCapacity": { "description": "Total volume capacity of the open volumes in the external parity group (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UnallocatedOpenVolumeCapacity": { "description": "From among the open volumes in the external parity group, the total capacity of volumes to which paths are not allocated (KB).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UsedCapacityRate": { "description": "Usage rate of the external parity group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiExternalParityGroup.List": { "title": "List of 'storage.HitachiExternalParityGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiExternalParityGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiExternalParityGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalParityGroup" }, "nullable": true } } } ] }, "storage.HitachiExternalPathGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiExternalPathGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiExternalPathGroup' resources.", "x-one-of-name": "storage.HitachiExternalPathGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalPathGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiExternalPathGroup": { "title": "Storage:Hitachi External Path Group", "description": "The HitachiExternalPathGroup object represents an external path group within the Hitachi storage array, providing functionalities for managing path settings and attributes.\n#### Purpose\nHitachiExternalPathGroup is designed to handle external path group operations, supporting the configuration and monitoring of path settings and serial numbers.\n#### Key Concepts\n- **Path Management:** Defines path group numbers, serial numbers, and product IDs for external path groups.\n- **Privilege Sets:** Ensures secure access and management of external path group entities with defined privilege sets.\n- **Licensing:** Supports operations under specified entitlements, complying with licensing requirements.", "x-allOf-name": "storage.HitachiExternalPathGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiExternalPathGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiExternalPathGroup" ], "default": "storage.HitachiExternalPathGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiExternalPathGroup" ], "default": "storage.HitachiExternalPathGroup", "x-enum-as-string": true }, "ExternalParityGroups": { "type": "array", "items": { "description": "The following properties are stored for each external parity group..", "$ref": "#/components/schemas/storage.ExternalParityGroup", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExternalPaths": { "type": "array", "items": { "description": "The following properties are restored for each LU on the external storage system.", "$ref": "#/components/schemas/storage.ExternalPath", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ExternalProductId": { "description": "Product ID of the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalSerialNumber": { "description": "Serial number of the external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "External path group number.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiExternalPathGroup.List": { "title": "List of 'storage.HitachiExternalPathGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiExternalPathGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiExternalPathGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalPathGroup" }, "nullable": true } } } ] }, "storage.HitachiExternalStorageLun.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiExternalStorageLun' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiExternalStorageLun' resources.", "x-one-of-name": "storage.HitachiExternalStorageLun.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStorageLun.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiExternalStorageLun": { "title": "Storage:Hitachi External Storage Lun", "description": "The HitachiExternalStorageLun object represents a list of logical units defined for external storage ports connected to the local storage system, supporting LUN management and operations.\n#### Purpose\nHitachiExternalStorageLun is designed to manage logical units within external storage ports, facilitating operations related to LUN settings and capacities.\n#### Key Concepts\n- **LUN Management:** Defines settings for LUNs, including port IDs, WWN, and capacity information for external storage systems.\n- **Privilege Sets:** Provides controlled access for managing external storage LUN settings with defined privilege sets.\n- **Licensing:** Supports operations under specified entitlements, adhering to licensing requirements.", "x-allOf-name": "storage.HitachiExternalStorageLun", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiExternalStorageLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiExternalStorageLun" ], "default": "storage.HitachiExternalStorageLun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiExternalStorageLun" ], "default": "storage.HitachiExternalStorageLun", "x-enum-as-string": true }, "ExternalLun": { "description": "LUN that can be referenced from the port on the external storage system.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalPortId": { "description": "Object ID of ports on an external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalVolumeCapacity": { "description": "Capacity of the external volume on the external storage system (1 block = 512 bytes).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ExternalVolumeInfo": { "description": "The product ID and the device identification (output in ASCII format) in the SCSI information for the external volume on the external storage system. This information is obtained in a format in which the product ID and the device identification are concatenated by a space.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalWwn": { "description": "WWN of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiIpAddress": { "description": "The iSCSI IP Address of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiName": { "description": "The iSCSI Name of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Port ID of the local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualPortId": { "description": "Virtual port ID. This attribute is displayed when an iSCSI port is used and virtual port mode is enabled.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExternalStoragePort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort.Relationship", "description": "A reference to a storageHitachiExternalStoragePort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiExternalStorageLun.List": { "title": "List of 'storage.HitachiExternalStorageLun' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiExternalStorageLun' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiExternalStorageLun' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStorageLun" }, "nullable": true } } } ] }, "storage.HitachiExternalStoragePort.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiExternalStoragePort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiExternalStoragePort' resources.", "x-one-of-name": "storage.HitachiExternalStoragePort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiExternalStoragePort.Relationship": { "description": "A relationship to the 'storage.HitachiExternalStoragePort' resource, or the expanded 'storage.HitachiExternalStoragePort' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiExternalStoragePort.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiExternalStoragePort": { "title": "Storage:Hitachi External Storage Port", "description": "The HitachiExternalStoragePort object defines a port entity for external storage systems connected to the local storage system, facilitating communication and connection management.\n#### Purpose\nHitachiExternalStoragePort serves as a critical component for managing external storage ports, supporting settings related to port IDs, WWN, and iSCSI configurations.\n#### Key Concepts\n- **Port Configuration:** Provides settings for port IDs, WWN, and iSCSI IP addresses for external storage ports.\n- **Privilege Sets:** Ensures controlled access for managing external storage port configurations with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized operations.", "x-allOf-name": "storage.HitachiExternalStoragePort", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiExternalStoragePort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiExternalStoragePort" ], "default": "storage.HitachiExternalStoragePort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiExternalStoragePort" ], "default": "storage.HitachiExternalStoragePort", "x-enum-as-string": true }, "ExternalIsUsed": { "description": "Is Used of the external storage.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ExternalPathMode": { "description": "Path Mode of the external storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalPortId": { "description": "Object ID of ports on an external storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalSerialNumber": { "description": "Serial Number of the external storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalStorageInfo": { "description": "Storage Information of the external storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExternalWwn": { "description": "WWN of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiIpAddress": { "description": "The iSCSI IP Address of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiName": { "description": "The iSCSI Name of the external storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Port ID of the local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualPortId": { "description": "Virtual port ID. This attribute is displayed when an iSCSI port is used and virtual port mode is enabled.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiExternalStoragePort.List": { "title": "List of 'storage.HitachiExternalStoragePort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiExternalStoragePort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiExternalStoragePort' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiExternalStoragePort" }, "nullable": true } } } ] }, "storage.HitachiHost.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiHost' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiHost' resources.", "x-one-of-name": "storage.HitachiHost.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiHost.Relationship": { "description": "A relationship to the 'storage.HitachiHost' resource, or the expanded 'storage.HitachiHost' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiHost.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiHost": { "title": "Storage:Hitachi Host", "description": "The HitachiHost object represents a host group entity in the Hitachi storage array, serving as an abstraction for organizing storage network addresses. It facilitates communication control between client computers and storage volumes.\n#### Purpose\nHitachiHost is critical for managing host groups, ensuring secure and efficient communication within storage networks through the organization of network addresses.\n#### Key Concepts\n- **Host Group Configuration:** Provides settings for port IDs, types, and security configurations within host groups.\n- **Authentication:** Supports iSCSI target authentication modes, enhancing security and access control.\n- **Privilege Sets:** Ensures secure management of host groups with defined access privileges.\n- **Licensing:** Operates under specified entitlements, supporting authorized operations.", "x-allOf-name": "storage.HitachiHost", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHost" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiHost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiHost" ], "default": "storage.HitachiHost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiHost" ], "default": "storage.HitachiHost", "x-enum-as-string": true }, "AuthenticationMode": { "description": "Authentication mode for the iSCSI target.\n* `N/A` - Authentication Mode is not available.\n* `CHAP` - CHAP-authentication mode.\n* `NONE` - Authentication mode is not set.\n* `BOTH` - Comply with Host Setting.", "type": "string", "enum": [ "N/A", "CHAP", "NONE", "BOTH" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "HostGroupId": { "description": "ID of the host group for this host.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostGroupNumber": { "description": "Host group number for this host.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "HostModeOptions": { "type": "array", "items": { "description": "Number of options for setting the host mode option of the host group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true }, "IsChapMutual": { "description": "Mutual CHAP setting that is Enabled or Disabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IscsiName": { "description": "IQN (iSCSI qualified name). Can be up to 255 characters long.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortId": { "description": "Port ID of the host group.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortLunSecurity": { "description": "LUN security setting for the port.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Host Group type, it can be FC or iSCSI.\n* `FC` - Port supports fibre channel protocol.\n* `iSCSI` - Port supports iSCSI protocol.\n* `FCoE` - Port supports fibre channel over ethernet protocol.", "type": "string", "enum": [ "FC", "iSCSI", "FCoE" ], "default": "FC", "readOnly": true, "x-omitempty": true }, "Wwn": { "description": "World wide port name, 64 bit address represented in hexa decimal notation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiHost.List": { "title": "List of 'storage.HitachiHost' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiHost' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiHost' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost" }, "nullable": true } } } ] }, "storage.HitachiHostLun.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiHostLun' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiHostLun' resources.", "x-one-of-name": "storage.HitachiHostLun.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHostLun.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiHostLun": { "title": "Storage:Hitachi Host Lun", "description": "The HitachiHostLun object represents a host LUN entity within a Hitachi storage array. It facilitates public connections to hosts within host groups, supporting effective data access and communication.\n#### Purpose\nHitachiHostLun is integral to managing host LUNs within Hitachi arrays. It enables seamless connectivity to volumes, ensuring efficient data access and resource allocation.\n#### Key Concepts\n- **Public Connectivity:** Provides shared access to volumes across hosts within a host group, simplifying data access management.\n- **Volume Association:** Links host LUNs to specific volumes, supporting streamlined access and resource allocation.\n- **Host Group Integration:** Connects host LUNs to host groups, ensuring reliable communication pathways.\n- **Security and Control:** Implements settings for port and LUN security, enhancing access control and data protection.", "x-allOf-name": "storage.HitachiHostLun", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHostLun" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiHostLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiHostLun" ], "default": "storage.HitachiHostLun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiHostLun" ], "default": "storage.HitachiHostLun", "x-enum-as-string": true }, "PortId": { "description": "Port ID of the Hitachi host lun.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Host": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHost.Relationship", "description": "A reference to a storageHitachiHost resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volume": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume.Relationship", "description": "A reference to a storageHitachiVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiHostLun.List": { "title": "List of 'storage.HitachiHostLun' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiHostLun' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiHostLun' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiHostLun" }, "nullable": true } } } ] }, "storage.HitachiInitiator": { "title": "Storage:Hitachi Initiator", "description": "An initiator is the consumer of Hitachi Array, typically a server with an adapter card in it called a Host Bus Adapter (HBA). The initiator \"initiates\" a connection over the fabric to one or more ports on Hitachi Array ports.", "x-allOf-name": "storage.HitachiInitiator", "allOf": [ { "$ref": "#/components/schemas/storage.BaseInitiator" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiInitiator', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiInitiator" ], "default": "storage.HitachiInitiator", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiInitiator" ], "default": "storage.HitachiInitiator", "x-enum-as-string": true }, "Wwpn": { "description": "World wide port name, 64 bit address represented in hexa decimal notation.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.HitachiNvmSubsystem.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiNvmSubsystem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiNvmSubsystem' resources.", "x-one-of-name": "storage.HitachiNvmSubsystem.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiNvmSubsystem.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiNvmSubsystem": { "title": "Storage:Hitachi Nvm Subsystem", "description": "The HitachiNvmSubsystem object represents an NVM subsystem entity within the Hitachi storage array, providing functionalities for managing NVMe-oF connections and subsystems.\n#### Purpose\nHitachiNvmSubsystem serves as a critical component for managing NVM subsystems, supporting operations related to subsystem settings, security configurations, and namespace management.\n#### Key Concepts\n- **Subsystem Management:** Provides settings for subsystem IDs, security configurations, and namespace management within NVMe-oF connections.\n- **Privilege Sets:** Ensures controlled access for managing NVM subsystem configurations with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized operations.", "x-allOf-name": "storage.HitachiNvmSubsystem", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiNvmSubsystem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiNvmSubsystem" ], "default": "storage.HitachiNvmSubsystem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiNvmSubsystem" ], "default": "storage.HitachiNvmSubsystem", "x-enum-as-string": true }, "HostMode": { "description": "Host mode of the NVM subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostModeOptions": { "type": "array", "items": { "description": "Number of the host mode option set for the NVM subsystem.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "nullable": true }, "HostNqns": { "type": "array", "items": { "description": "Some properties related to a host NQN registered in the NVM subsystem are stored.", "$ref": "#/components/schemas/storage.HostNqn", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "NVM subsystem ID. NVM subsystem is a resource to manage system components in an NVMe-oF connection.", "type": "string", "readOnly": true, "x-omitempty": true }, "NamespacePaths": { "type": "array", "items": { "description": "Some properties related to a host-namespace path that is set to the NVM subsystem are stored.", "$ref": "#/components/schemas/storage.NamespacePath", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NamespaceSecuritySetting": { "description": "Namespace security settings.", "type": "string", "readOnly": true, "x-omitempty": true }, "Namespaces": { "type": "array", "items": { "description": "Some properties related to a namespace created in the NVM subsystem are stored.", "$ref": "#/components/schemas/storage.Namespace", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NvmSubsystemName": { "description": "NVM subsystem name. Can be up to 32 characters long.", "type": "string", "readOnly": true, "x-omitempty": true }, "NvmSubsystemNqn": { "description": "Subsystem NQN. If the NVM subsystem is virtualized, the NQN of the virtualized NVM subsystem is output.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortIds": { "type": "array", "items": { "description": "NVM subsystem ports that are set to the NVM subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ResourceGroupId": { "description": "Resource group ID of the resource group to which the NVM subsystem belongs.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "T10piMode": { "description": "Status of the T10 PI mode of the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualNvmSubsystemId": { "description": "The Virtual NVM Subsystem ID property is applicable for use with storage systems in the VSP 5000 series.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiNvmSubsystem.List": { "title": "List of 'storage.HitachiNvmSubsystem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiNvmSubsystem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiNvmSubsystem' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiNvmSubsystem" }, "nullable": true } } } ] }, "storage.HitachiParityGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiParityGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiParityGroup' resources.", "x-one-of-name": "storage.HitachiParityGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiParityGroup.Relationship": { "description": "A relationship to the 'storage.HitachiParityGroup' resource, or the expanded 'storage.HitachiParityGroup' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiParityGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiParityGroup": { "title": "Storage:Hitachi Parity Group", "description": "The HitachiParityGroup object defines a parity group within the Hitachi storage array, encapsulating key attributes related to disk configurations and settings.\n#### Purpose\nHitachiParityGroup serves as the foundational element for managing parity groups, supporting operations related to disk types, speeds, and compression settings.\n#### Key Concepts\n- **Disk Management:** Manages disk types, speeds, and settings related to accelerated compression and encryption.\n- **Privilege Sets:** Provides controlled access for managing parity group settings with defined privilege sets.\n- **Licensing:** Ensures operations are performed under specified entitlements, adhering to licensing requirements.", "x-allOf-name": "storage.HitachiParityGroup", "allOf": [ { "$ref": "#/components/schemas/storage.BaseRaidGroup" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiParityGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiParityGroup" ], "default": "storage.HitachiParityGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiParityGroup" ], "default": "storage.HitachiParityGroup", "x-enum-as-string": true }, "DiskSpeed": { "description": "Speed (rpm) of the disk belonging to the parity group.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskType": { "description": "Type of the disk belonging to the parity group.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsAcceleratedCompressionEnabled": { "description": "Value of the accelerated compression of the parity group. true, Accelerated compression for the parity group is enabled. false, Accelerated compression for the parity group is disabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsCopyBackModeEnabled": { "description": "Value of the copy back mode setting of the parity group. true, Copy back mode is enabled. false, Copy back mode is disabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsEncryptionEnabled": { "description": "Value of the encryption setting of the parity group. true, Encryption is enabled. false, Encryption is disabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiParityGroup.List": { "title": "List of 'storage.HitachiParityGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiParityGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiParityGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup" }, "nullable": true } } } ] }, "storage.HitachiPool.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiPool' resources.", "x-one-of-name": "storage.HitachiPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiPool.Relationship": { "description": "A relationship to the 'storage.HitachiPool' resource, or the expanded 'storage.HitachiPool' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiPool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiPool": { "title": "Storage:Hitachi Pool", "description": "The HitachiPool object represents a pool entity within the Hitachi storage array, designed to manage and configure storage pools efficiently. This provides functionalities for monitoring and executing various operations related to storage pool management.\n#### Purpose\nHitachiPool serves as a pivotal element for managing storage pools, supporting the definition of execution modes, monitoring settings, and capacity thresholds.\n#### Key Concepts\n- **Capacity Management:** Handles total reserved capacity and threshold settings, ensuring optimal pool performance and resource allocation.\n- **Monitoring:** Supports performance monitoring execution modes, providing insights into pool operations.\n- **Privilege Sets:** Offers controlled access for pool management tasks with defined privilege sets.\n- **Licensing:** Complies with licensing operations under specified entitlements.", "x-allOf-name": "storage.HitachiPool", "allOf": [ { "$ref": "#/components/schemas/storage.BaseDiskPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiPool" ], "default": "storage.HitachiPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiPool" ], "default": "storage.HitachiPool", "x-enum-as-string": true }, "BlockingModeBlockade": { "description": "Setting the protection function for a virtual volume. When the DP pool is blockade, whether the read and write operations can be performed for the DP volume that uses the target DP pool is output. Yes, read and write operations are not possible. No, read and write operations are possible. -, Thin Image pool or not available.", "type": "string", "readOnly": true, "x-omitempty": true }, "BlockingModeFull": { "description": "Setting the protection function for a virtual volume. When the DP pool is full, whether the read and write operations can be performed for the DP volume that uses the target DP pool is output. Yes, read and write operations are not possible. No, read and write operations are possible. -, Thin Image pool or not available.", "type": "string", "readOnly": true, "x-omitempty": true }, "DepletionThreshold": { "description": "The depletion threshold set for the pool (%).", "type": "string", "readOnly": true, "x-omitempty": true }, "IsShrinking": { "description": "Whether the pool is shrinking is output.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MonitoringMode": { "description": "Performance monitoring execution mode (monitor mode).\n* `N/A` - Performance monitoring is not available.\n* `Period mode` - Period mode is the default setting. If Period mode is enabled, tier range values and page relocations are determined based solely on the monitoring data from the last complete cycle.\n* `Continuous mode` - When Continuous mode is enabled, the weighted average efficiency is calculated using the latest monitoring information and the collected monitoring information in the past cycles. Page relocations are determined using this weighted average efficiency.", "type": "string", "enum": [ "N/A", "Period mode", "Continuous mode" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "MonitoringStatus": { "description": "Status of monitor information.", "type": "string", "readOnly": true, "x-omitempty": true }, "PoolActionMode": { "description": "Execution mode for the pool.\n* `N/A` - Execution Mode is not available for the pool.\n* `Auto` - The mode in which the monitor is started or stopped at the specified time, and the Tier range is specified by automatic calculation of the DKC (specified by using Storage Navigator).\n* `Manual` - The mode in which the monitor is started or stopped by instructions from the REST API server, and the Tier range is specified by automatic calculation of the DKC.", "type": "string", "enum": [ "N/A", "Auto", "Manual" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "ProgressOfReplacing": { "description": "Displays the status of the tier relocation processing.", "type": "string", "readOnly": true, "x-omitempty": true }, "TotalReservedCapacity": { "description": "Total capacity of the reserved page (bytes) of the DP volume that is related to the DP pool.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "WarningThreshold": { "description": "The warning threshold set for the pool (%).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiPool.List": { "title": "List of 'storage.HitachiPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiPool' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool" }, "nullable": true } } } ] }, "storage.HitachiPort.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiPort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiPort' resources.", "x-one-of-name": "storage.HitachiPort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiPort": { "title": "Storage:Hitachi Port", "description": "The HitachiPort object encapsulates the characteristics of a port entity within a Hitachi storage array. It is essential for managing port configurations and security settings, supporting effective storage network operations.\n#### Purpose\nHitachiPort is vital to managing ports within Hitachi arrays. This provides control over port settings and security, ensuring reliable and secure network communication.\n#### Key Concepts\n- **Port Configuration:** Details settings and properties of storage ports, supporting efficient network management.\n- **Security Settings:** Implements security measures for ports, enhancing protection against unauthorized access.\n- **Network Management:** Facilitates management of network addresses and configurations, ensuring streamlined communication.\n- **Access Control:** Utilizes privilege sets to ensure secure and authorized operations on ports.", "x-allOf-name": "storage.HitachiPort", "allOf": [ { "$ref": "#/components/schemas/storage.BasePhysicalPort" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiPort" ], "default": "storage.HitachiPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiPort" ], "default": "storage.HitachiPort", "x-enum-as-string": true }, "FabricMode": { "description": "Fabric mode of the port. true, Set. false, Not set.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Ipv4Address": { "description": "IPv4 address of Hitachi Port.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "Ipv6GlobalAddress": { "description": "IPv6 global address value.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "Ipv6LinkLocalAddress": { "description": "IPv6 link local address value.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "IsIpv6Enable": { "description": "Determines if IPv6 mode is enabled on the port.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LoopId": { "description": "The value set for the port loop ID (AL_PA).", "type": "string", "readOnly": true, "x-omitempty": true }, "PortConnection": { "description": "Topology setting for the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortLunSecurity": { "description": "LUN security setting for the port.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PortMode": { "description": "Operation mode of the port. Possible values are FC-NVMe, FCP-SCSI, and NOT SUPPORTED.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortType": { "description": "Port type of the Hitachi port.", "type": "string", "readOnly": true, "x-omitempty": true }, "ShortportId": { "description": "Port ID (short) of the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "TcpMtu": { "description": "Value of MTU for iSCSI communication.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiPort.List": { "title": "List of 'storage.HitachiPort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiPort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiPort' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPort" }, "nullable": true } } } ] }, "storage.HitachiRemoteCopyPairGad.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiRemoteCopyPairGad' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiRemoteCopyPairGad' resources.", "x-one-of-name": "storage.HitachiRemoteCopyPairGad.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairGad.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiRemoteCopyPairGad": { "title": "Storage:Hitachi Remote Copy Pair Gad", "description": "The HitachiRemoteCopyPairGad object represents the global-active device pair entity within the Hitachi storage array, focusing on replication management and operations.\n#### Purpose\nHitachiRemoteCopyPairGad is designed to manage global-active device pairs, supporting replication operations and monitoring of pair attributes.\n#### Key Concepts\n- **Replication Operations:** Manages replication types, LDEV numbers, and status information for global-active device pairs.\n- **Privilege Sets:** Provides controlled access for managing global-active device pair settings with defined privilege sets.\n- **Licensing:** Supports operations under specified entitlements, adhering to licensing requirements.", "x-allOf-name": "storage.HitachiRemoteCopyPairGad", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiRemoteCopyPairGad', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiRemoteCopyPairGad" ], "default": "storage.HitachiRemoteCopyPairGad", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiRemoteCopyPairGad" ], "default": "storage.HitachiRemoteCopyPairGad", "x-enum-as-string": true }, "CreatedLocalTime": { "description": "Time at which the pair was created. The local time of the storage system is displayed.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsSsws": { "description": "Indicates whether the state of the volume on the local storage system is SSWS.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MuNumber": { "description": "MU (mirror unit) number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Object ID of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PvolStorageSerial": { "description": "Serial number of the storage system on the P-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuorumDiskId": { "description": "ID of the Quorum disk. A value is input only in the case of global-active device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationType": { "description": "Pair type of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "SuspendedMode": { "description": "Block or Remote instructions when a pair is suspended.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of secondary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvolStorageSerial": { "description": "Serial number of the storage system on the S-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiRemoteCopyPairGad.List": { "title": "List of 'storage.HitachiRemoteCopyPairGad' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiRemoteCopyPairGad' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiRemoteCopyPairGad' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairGad" }, "nullable": true } } } ] }, "storage.HitachiRemoteCopyPairTc.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiRemoteCopyPairTc' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiRemoteCopyPairTc' resources.", "x-one-of-name": "storage.HitachiRemoteCopyPairTc.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairTc.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiRemoteCopyPairTc": { "title": "Storage:Hitachi Remote Copy Pair Tc", "description": "The HitachiRemoteCopyPairTc object represents a TrueCopy pair entity within the Hitachi storage array, focused on replication management and operations.\n#### Purpose\nHitachiRemoteCopyPairTc is designed to manage TrueCopy pairs, facilitating replication operations and monitoring of pair attributes.\n#### Key Concepts\n- **Replication Operations:** Manages replication types, LDEV numbers, and status information for TrueCopy pairs.\n- **Privilege Sets:** Provides controlled access for managing TrueCopy pair settings with defined privilege sets.\n- **Licensing:** Supports operations under specified entitlements, adhering to licensing requirements.", "x-allOf-name": "storage.HitachiRemoteCopyPairTc", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiRemoteCopyPairTc', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiRemoteCopyPairTc" ], "default": "storage.HitachiRemoteCopyPairTc", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiRemoteCopyPairTc" ], "default": "storage.HitachiRemoteCopyPairTc", "x-enum-as-string": true }, "MuNumber": { "description": "MU (mirror unit) number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Object ID of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PvolStorageSerial": { "description": "Serial number of the storage system on the P-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationType": { "description": "Pair type of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of secondary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvolStorageSerial": { "description": "Serial number of the storage system on the S-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiRemoteCopyPairTc.List": { "title": "List of 'storage.HitachiRemoteCopyPairTc' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiRemoteCopyPairTc' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiRemoteCopyPairTc' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairTc" }, "nullable": true } } } ] }, "storage.HitachiRemoteCopyPairUr.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiRemoteCopyPairUr' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiRemoteCopyPairUr' resources.", "x-one-of-name": "storage.HitachiRemoteCopyPairUr.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairUr.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiRemoteCopyPairUr": { "title": "Storage:Hitachi Remote Copy Pair Ur", "description": "The HitachiRemoteCopyPairUr object defines a Universal Replicator pair entity within the Hitachi storage array, supporting replication management and operations.\n#### Purpose\nHitachiRemoteCopyPairUr serves as a central component for managing Universal Replicator pairs, facilitating replication operations and monitoring of pair settings.\n#### Key Concepts\n- **Replication Management:** Provides settings for replication types, LDEV numbers, and status information for Universal Replicator pairs.\n- **Privilege Sets:** Ensures secure access and management of replication entities with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized replication operations.", "x-allOf-name": "storage.HitachiRemoteCopyPairUr", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiRemoteCopyPairUr', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiRemoteCopyPairUr" ], "default": "storage.HitachiRemoteCopyPairUr", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiRemoteCopyPairUr" ], "default": "storage.HitachiRemoteCopyPairUr", "x-enum-as-string": true }, "MuNumber": { "description": "MU (mirror unit) number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Object ID of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PvolStorageSerial": { "description": "Serial number of the storage system on the P-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationType": { "description": "Pair type of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of secondary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvolStorageSerial": { "description": "Serial number of the storage system on the S-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiRemoteCopyPairUr.List": { "title": "List of 'storage.HitachiRemoteCopyPairUr' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiRemoteCopyPairUr' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiRemoteCopyPairUr' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteCopyPairUr" }, "nullable": true } } } ] }, "storage.HitachiRemoteReplication.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiRemoteReplication' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiRemoteReplication' resources.", "x-one-of-name": "storage.HitachiRemoteReplication.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteReplication.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiRemoteReplication": { "title": "Storage:Hitachi Remote Replication", "description": "The HitachiRemoteReplication object represents a remote copy pair entity within the Hitachi storage array, providing essential functionalities for replication operations.\n#### Purpose\nHitachiRemoteReplication serves as a critical component for managing remote replication operations, supporting the configuration and monitoring of copy pairs.\n#### Key Concepts\n- **Replication Management:** Defines replication types, journal IDs, and status information for remote copy pairs.\n- **Privilege Sets:** Ensures secure access and management of replication entities with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized replication operations.", "x-allOf-name": "storage.HitachiRemoteReplication", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiRemoteReplication', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiRemoteReplication" ], "default": "storage.HitachiRemoteReplication", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiRemoteReplication" ], "default": "storage.HitachiRemoteReplication", "x-enum-as-string": true }, "ConsistencyGroupId": { "description": "Consistency group ID. If no consistency group consists, information is not input.", "type": "string", "readOnly": true, "x-omitempty": true }, "CopyPace": { "description": "Copy speed. Number for the size of tracks to be copied.", "type": "string", "readOnly": true, "x-omitempty": true }, "DeltaStatus": { "description": "Status of the 3DC multi-target configuration that uses delta resync.", "type": "string", "readOnly": true, "x-omitempty": true }, "FenceLevel": { "description": "Fence level. Whether the P-VOL can be written to when the pair is split due to error.", "type": "string", "readOnly": true, "x-omitempty": true }, "MuNumber": { "description": "MU (mirror unit) number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Object ID of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "PathGroupId": { "description": "Path group ID of the RCU.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolIoMode": { "description": "I-O mode of the P-VOL. Information is input only in the case of global-active device.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolJournalId": { "description": "Journal ID of the P-VOL. A value is input only in the case of Universal Replicator.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PvolStorageSerial": { "description": "Serial number of the storage system on the P-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuorumDiskId": { "description": "ID of the Quorum disk. A value is input only in the case of global-active device.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReplicationType": { "description": "Pair type of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status of the remote copy pair.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolIoMode": { "description": "I-O mode of the S-VOL. Information is input only in the case of global-active device.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolJournalId": { "description": "Journal ID of the S-VOL. A value is input only in the case of Universal Replicator.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of secondary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvolStorageSerial": { "description": "Serial number of the storage system on the S-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiRemoteReplication.List": { "title": "List of 'storage.HitachiRemoteReplication' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiRemoteReplication' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiRemoteReplication' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiRemoteReplication" }, "nullable": true } } } ] }, "storage.HitachiSnapshot.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiSnapshot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiSnapshot' resources.", "x-one-of-name": "storage.HitachiSnapshot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiSnapshot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiSnapshot": { "title": "Storage:Hitachi Snapshot", "description": "The HitachiSnapshot object represents a snapshot entity within the Hitachi storage array, providing functionalities for managing snapshot data and operations.\n#### Purpose\nHitachiSnapshot is designed to handle snapshot operations, facilitating the creation, management, and monitoring of snapshot groups and volumes.\n#### Key Concepts\n- **Snapshot Management:** Defines snapshot group names, LDEV numbers, and status information for snapshot operations.\n- **Privilege Sets:** Ensures secure access and management of snapshot entities with defined privilege sets.\n- **Licensing:** Supports operations under specified entitlements, complying with licensing requirements.", "x-allOf-name": "storage.HitachiSnapshot", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiSnapshot" ], "default": "storage.HitachiSnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiSnapshot" ], "default": "storage.HitachiSnapshot", "x-enum-as-string": true }, "ConcordanceRate": { "description": "Concordance rate for pairs.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IsConsistencyGroup": { "description": "Whether the pair was created in the consistency group mode (CTG mode).", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsMultistageable": { "description": "Whether the pair can be a multistage pair.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "IsRedirectOnWrite": { "description": "Returns whether it is a Thin Image Advanced pair.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "MuNumber": { "description": "MU number of the primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Object ID of the pair for snapshot data.", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of the primary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SnapshotGroupName": { "description": "Name of the snapshot group that contains the pair for snapshot data.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotPoolId": { "description": "ID of the pool in which the snapshot data is created.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SplitTime": { "description": "Time when snapshot data was created.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Pair status. Pair status changes according to the pair operation.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of the secondary volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiSnapshot.List": { "title": "List of 'storage.HitachiSnapshot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiSnapshot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiSnapshot' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiSnapshot" }, "nullable": true } } } ] }, "storage.HitachiVolume.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiVolume' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiVolume' resources.", "x-one-of-name": "storage.HitachiVolume.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiVolume.Relationship": { "description": "A relationship to the 'storage.HitachiVolume' resource, or the expanded 'storage.HitachiVolume' resource, or the 'null' value.", "x-one-of-name": "storage.HitachiVolume.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HitachiVolume": { "title": "Storage:Hitachi Volume", "description": "The HitachiVolume object defines a volume entity within a Hitachi storage array. It encapsulates essential aspects of storage volumes, including their attributes, status, and associated pools and parity groups.\n#### Purpose\nHitachiVolume serves as the core component for managing storage volumes, facilitating operations such as viewing, management, and status monitoring within storage arrays.\n#### Key Concepts\n- **Volume Association:** Connects volumes to arrays and pools, providing comprehensive relationship management.\n- **Data Reduction:** Integrates capacity-saving functions through deduplication and compression settings.\n- **Privilege Sets:** Ensures secure access and management with defined privilege sets for volume-related operations.\n- **Licensing:** Operates under specific entitlements, adhering to licensing requirements.", "x-allOf-name": "storage.HitachiVolume", "allOf": [ { "$ref": "#/components/schemas/storage.BaseVolume" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiVolume', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiVolume" ], "default": "storage.HitachiVolume", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiVolume" ], "default": "storage.HitachiVolume", "x-enum-as-string": true }, "Attributes": { "type": "array", "items": { "description": "Volume attributes configured in the storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ClprId": { "description": "CLPR (Cache Logical Partition) number of this volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DataReductionMode": { "description": "Setting of the capacity saving function (dedupe and compression).\n* `N/A` - The capacity saving function is not available.\n* `Compression` - The capacity saving function (compression) is enabled.\n* `Compression Deduplication` - The capacity saving function (compression and deduplication) is enabled.\n* `Disabled` - The capacity saving function (compression and deduplication) is disabled.", "type": "string", "enum": [ "N/A", "Compression", "Compression Deduplication", "Disabled" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "DataReductionStatus": { "description": "Status of the capacity saving function.\n* `N/A` - The capacity saving function is not available.\n* `Enabled` - The capacity saving function is enabled.\n* `Disabled` - The capacity saving function is disabled.\n* `Enabling` - The capacity saving function is being enabled.\n* `Rehydrating` - The capacity saving function is being disabled.\n* `Deleting` - The volumes for which the capacity saving function is enabled are being deleted.\n* `Failed` - An attempt to enable the capacity saving function failed.", "type": "string", "enum": [ "N/A", "Enabled", "Disabled", "Enabling", "Rehydrating", "Deleting", "Failed" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "DriveType": { "description": "Code indicating the drive type of the drive belonging to the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "EmulationType": { "description": "The volume emulation type or the volume status information.\n* `N/A` - The emulation type is not available.\n* `NOT DEFINED` - The volume is not implemented.\n* `DEFINING` - The volume is being created.\n* `REMOVING` - The volume is being removed.\n* `OPEN-V` - To be provided by Hitachi.", "type": "string", "enum": [ "N/A", "NOT DEFINED", "DEFINING", "REMOVING", "OPEN-V" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "IsFullAllocationEnabled": { "description": "Whether pages are reserved by the FullAllocation functionality.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Label": { "description": "Label of the volume, as configured in the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "NamespaceId": { "description": "Namespace ID registered in NVM Subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumOfPaths": { "description": "Number of paths set for the volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NvmSubsystemId": { "description": "NVM subsystem ID on storage system.", "type": "string", "readOnly": true, "x-omitempty": true }, "ParityGroupIds": { "type": "array", "items": { "description": "Parity groups to which the volume belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PoolId": { "description": "ID of the pool with which the volume is associated.", "type": "string", "readOnly": true, "x-omitempty": true }, "RaidLevel": { "description": "RAID level for the volume.\n* `N/A` - RAID level is unknown or multiple RAID levels are being used.\n* `RAID1` - RAID level of the given drives is RAID1.\n* `RAID5` - RAID level of the given drives is RAID5.\n* `RAID6` - RAID level of the given drives is RAID6.", "type": "string", "enum": [ "N/A", "RAID1", "RAID5", "RAID6" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "RaidType": { "description": "RAID type drive configuration.", "type": "string", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status information of the volume.\n* `N/A` - The volume status is not available.\n* `NML` - The volume is in normal status.\n* `BLK` - The volume is in blocked state.\n* `BSY` - The volume status is being changed.\n* `Unknown` - The volume status is unknown (not supported).", "type": "string", "enum": [ "N/A", "NML", "BLK", "BSY", "Unknown" ], "default": "N/A", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ParityGroups": { "description": "An array of relationships to storageHitachiParityGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiParityGroup.Relationship" }, "nullable": true, "readOnly": true }, "Pool": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiPool.Relationship", "description": "A reference to a storageHitachiPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiVolume.List": { "title": "List of 'storage.HitachiVolume' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiVolume' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiVolume' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolume" }, "nullable": true } } } ] }, "storage.HitachiVolumeMigrationPair.Response": { "description": "The response body of a HTTP GET request for the 'storage.HitachiVolumeMigrationPair' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HitachiVolumeMigrationPair' resources.", "x-one-of-name": "storage.HitachiVolumeMigrationPair.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolumeMigrationPair.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HitachiVolumeMigrationPair": { "title": "Storage:Hitachi Volume Migration Pair", "description": "The HitachiVolumeMigrationPair object defines a copy pair used for volume migration within the Hitachi storage array, focusing on migration operations and pair management.\n#### Purpose\nHitachiVolumeMigrationPair serves as a pivotal element for managing volume migration pairs, supporting operations related to copy modes and pair statuses.\n#### Key Concepts\n- **Migration Operations:** Manages copy modes, LDEV numbers, and status information for volume migration pairs.\n- **Privilege Sets:** Ensures secure access and management of migration pair settings with defined privilege sets.\n- **Licensing:** Operates under specified entitlements, supporting authorized migration operations.", "x-allOf-name": "storage.HitachiVolumeMigrationPair", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HitachiVolumeMigrationPair', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HitachiVolumeMigrationPair" ], "default": "storage.HitachiVolumeMigrationPair", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HitachiVolumeMigrationPair" ], "default": "storage.HitachiVolumeMigrationPair", "x-enum-as-string": true }, "CopyMode": { "description": "Copy mode. NotSynchronized or VolumeMigration is stored.", "type": "string", "readOnly": true, "x-omitempty": true }, "LocalCloneCopypairId": { "description": "Object ID of the pair. The following informations of pair are output, separated by commas. , , , .", "type": "string", "readOnly": true, "x-omitempty": true }, "PvolLdevId": { "description": "LDEV number of the P-VOL (source volume) with a decimal (base 10) number.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PvolStatus": { "description": "Pair volume status of the P-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvolLdevId": { "description": "LDEV number of the S-VOL (target volume) with a decimal (base 10) number.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvolStatus": { "description": "Pair volume status of the S-VOL.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiArray.Relationship", "description": "A reference to a storageHitachiArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HitachiVolumeMigrationPair.List": { "title": "List of 'storage.HitachiVolumeMigrationPair' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HitachiVolumeMigrationPair' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HitachiVolumeMigrationPair' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.HitachiVolumeMigrationPair" }, "nullable": true } } } ] }, "storage.HostNqn": { "title": "Storage:Host Nqn", "description": "Informations of host NQN registered in the NVM subsystem are stored.", "x-allOf-name": "storage.HostNqn", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HostNqn', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HostNqn" ], "default": "storage.HostNqn", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HostNqn" ], "default": "storage.HostNqn", "x-enum-as-string": true }, "HostNqn": { "description": "Host NQN registered in the NVM subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "HostNqnNickname": { "description": "Nickname of the Host NQN.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.HyperFlexIscsiInitiator": { "title": "Storage:Hyper Flex Iscsi Initiator", "description": "An iSCSI initiator is an iSCSI endpoint which initiates a session with the iSCSI target present in the HyperFlex cluster. The iSCSI endpoint should have access to the iSCSI network.", "x-allOf-name": "storage.HyperFlexIscsiInitiator", "allOf": [ { "$ref": "#/components/schemas/storage.BaseInitiator" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HyperFlexIscsiInitiator', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HyperFlexIscsiInitiator" ], "default": "storage.HyperFlexIscsiInitiator", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HyperFlexIscsiInitiator" ], "default": "storage.HyperFlexIscsiInitiator", "x-enum-as-string": true }, "IpAddresses": { "type": "array", "items": { "description": "The IP Addresses of iSCSI endpoint which initiates a session with iSCSI target.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "storage.HyperFlexStorageContainer.Response": { "description": "The response body of a HTTP GET request for the 'storage.HyperFlexStorageContainer' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HyperFlexStorageContainer' resources.", "x-one-of-name": "storage.HyperFlexStorageContainer.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HyperFlexStorageContainer.Relationship": { "description": "A relationship to the 'storage.HyperFlexStorageContainer' resource, or the expanded 'storage.HyperFlexStorageContainer' resource, or the 'null' value.", "x-one-of-name": "storage.HyperFlexStorageContainer.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HyperFlexStorageContainer": { "title": "Storage:Hyper Flex Storage Container", "description": "The HyperFlexStorageContainer object is a critical component of the HyperFlex storage architecture, representing a Storage Container (or Datastore) entity. It plays a pivotal role in managing and organizing the storage resources within a HyperFlex cluster.\n#### Purpose\nThe primary purpose of the HyperFlexStorageContainer is to provide a structured and efficient way to manage storage allocations and utilization within a HyperFlex environment. It acts as a container for data storage, supporting various storage types and ensuring optimal data management.\n#### Key Concepts\n- **Storage Management:** Facilitates the organization and management of storage resources, allowing for efficient allocation and utilization of space within a cluster.\n- **Data Integrity:** Ensures the reliability and consistency of data storage, supporting various storage types such as SMB, NFS, and iSCSI.\n- **Access Control:** Offers a robust access control system with privilege sets, ensuring that only authorized personnel can manage storage arrays.\n- **Integration:** Seamlessly integrates with the HyperFlex cluster's infrastructure, providing essential storage services and capabilities.", "x-allOf-name": "storage.HyperFlexStorageContainer", "allOf": [ { "$ref": "#/components/schemas/storage.BaseStorageContainer" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HyperFlexStorageContainer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HyperFlexStorageContainer" ], "default": "storage.HyperFlexStorageContainer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HyperFlexStorageContainer" ], "default": "storage.HyperFlexStorageContainer", "x-enum-as-string": true }, "DataBlockSize": { "description": "Storage Container data block size", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InUse": { "description": "Indicates whether the Storage Container has Volumes.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LastAccessTime": { "description": "Storage container's last access time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastModifiedTime": { "description": "Storage container's last modified time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "ProvisionedCapacity": { "description": "Provisioned Capacity of the Storage container.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ProvisionedVolumeCapacityUtilization": { "description": "Provisioned Capacity Utilization of All Volumes associated with the Storage Container.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Storage Container type (SMB/NFS/iSCSI).\n* `NFS` - Storage container created/accesed through NFS protocol.\n* `SMB` - Storage container created/accessed through SMB protocol.\n* `iSCSI` - Storage container created/accessed through iSCSI protocol.", "type": "string", "enum": [ "NFS", "SMB", "iSCSI" ], "default": "NFS", "readOnly": true, "x-omitempty": true }, "UnCompressedUsedBytes": { "description": "Uncompressed bytes on Storage Container.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID of the Datastore/Storage Containter.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeCount": { "description": "Number of Volumes associated with the Storage Container.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/hyperflex.Cluster.Relationship", "description": "A reference to a hyperflexCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HyperFlexStorageContainer.List": { "title": "List of 'storage.HyperFlexStorageContainer' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HyperFlexStorageContainer' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HyperFlexStorageContainer' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer" }, "nullable": true } } } ] }, "storage.HyperFlexVolume.Response": { "description": "The response body of a HTTP GET request for the 'storage.HyperFlexVolume' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.HyperFlexVolume' resources.", "x-one-of-name": "storage.HyperFlexVolume.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.HyperFlexVolume.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.HyperFlexVolume.Relationship": { "description": "A relationship to the 'storage.HyperFlexVolume' resource, or the expanded 'storage.HyperFlexVolume' resource, or the 'null' value.", "x-one-of-name": "storage.HyperFlexVolume.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.HyperFlexVolume" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.HyperFlexVolume": { "title": "Storage:Hyper Flex Volume", "description": "The HyperFlexVolume object represents a HyperFlex Volume entity, which is integral to the storage capabilities of the HyperFlex system. It encapsulates the essential attributes and functionalities of a volume within the HyperFlex storage architecture.\n#### Purpose\nHyperFlexVolume serves as the primary entity for managing volume storage within a HyperFlex cluster. It provides essential capabilities for volume management, ensuring efficient storage operations and data handling.\n#### Key Concepts\n- **Volume Management:** Supports the creation, configuration, and maintenance of volumes, essential for organizing storage resources in a HyperFlex cluster.\n- **Data Handling:** Facilitates data storage operations, ensuring high performance and reliability within the storage environment.\n- **Access Control:** Implements comprehensive access control measures with privilege sets, allowing secure management of volume resources.\n- **Integration:** Works in conjunction with other storage components and systems, enabling a cohesive and efficient storage infrastructure.", "x-allOf-name": "storage.HyperFlexVolume", "allOf": [ { "$ref": "#/components/schemas/storage.BaseVolume" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.HyperFlexVolume', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.HyperFlexVolume" ], "default": "storage.HyperFlexVolume", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.HyperFlexVolume" ], "default": "storage.HyperFlexVolume", "x-enum-as-string": true }, "Capacity": { "description": "Provisioned Capacity of the Storage container in Bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ClientId": { "description": "Client ID to which the volume belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "LastModifiedTime": { "description": "Last modified time as UTC of the volume.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LunUuid": { "description": "UUID of Lun associated with the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "SerialNumber": { "description": "Serial number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID of the Datastore/Storage Containter.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeAccessMode": { "description": "Access Mode of the volume.\n* `ReadWriteOnce` - Read write permisisons to a Virtual disk by a single virtual machine.\n* `ReadWriteMany` - Read write permisisons to a Virtual disk by multiple virtual machines.\n* `ReadOnlyMany` - Read only permisisons to a Virtual disk by multiple virtual machines.\n* `` - Unknown disk access mode.", "type": "string", "enum": [ "ReadWriteOnce", "ReadWriteMany", "ReadOnlyMany", "" ], "default": "ReadWriteOnce", "readOnly": true, "x-omitempty": true }, "VolumeMode": { "description": "Mode of the volume.\n* `Block` - It is a Block virtual disk.\n* `Filesystem` - It is a File system virtual disk.\n* `` - Disk mode is either unknown or not supported.", "type": "string", "enum": [ "Block", "Filesystem", "" ], "default": "Block", "readOnly": true, "x-omitempty": true }, "VolumeType": { "description": "The Type of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Cluster": { "$ref": "intersight-hyperflex-v3-1.0.11-20260807064027971.json#/components/schemas/hyperflex.Cluster.Relationship", "description": "A reference to a hyperflexCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageContainer": { "$ref": "#/components/schemas/storage.HyperFlexStorageContainer.Relationship", "description": "A reference to a storageHyperFlexStorageContainer resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.HyperFlexVolume.List": { "title": "List of 'storage.HyperFlexVolume' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.HyperFlexVolume' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.HyperFlexVolume' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.HyperFlexVolume" }, "nullable": true } } } ] }, "storage.Initiator": { "title": "Storage:Initiator", "description": "An initiator is the consumer of storage, typically a server with an adapter card in it called a Host Bus Adapter (HBA). The initiator \"initiates\" a connection over the fabric to one or more ports on storage system target ports.", "x-allOf-name": "storage.Initiator", "allOf": [ { "$ref": "#/components/schemas/storage.BaseInitiator" } ] }, "storage.InternalMoPhysicalDiskConfig": { "title": "Physical Disk state for Internal Mo", "description": "InternalMoPhysicalDiskConfig models physical disk config that needs to be created for Secure Drives Config on reboot. Used in activation workflow.", "x-allOf-name": "storage.InternalMoPhysicalDiskConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.InternalMoPhysicalDiskConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.InternalMoPhysicalDiskConfig" ], "default": "storage.InternalMoPhysicalDiskConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.InternalMoPhysicalDiskConfig" ], "default": "storage.InternalMoPhysicalDiskConfig", "x-enum-as-string": true }, "EncryptionOp": { "description": "Physical Disk Encryption operation that is to be set at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "Slot": { "description": "Physical Disk Slot that is to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "Physical Disk State that is to be set at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.Item.Response": { "description": "The response body of a HTTP GET request for the 'storage.Item' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.Item' resources.", "x-one-of-name": "storage.Item.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.Item.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.Item.Relationship": { "description": "A relationship to the 'storage.Item' resource, or the expanded 'storage.Item' resource, or the 'null' value.", "x-one-of-name": "storage.Item.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.Item" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.Item": { "title": "Storage:Item", "description": "The local Storage information.", "x-allOf-name": "storage.Item", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Item', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Item" ], "default": "storage.Item", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Item" ], "default": "storage.Item", "x-enum-as-string": true }, "AlarmType": { "description": "The alarmType of the Local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the Local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperState": { "description": "The operState of the Local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "The size (MiB) of the Local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "Used": { "description": "The used percent of the Local storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "UsedVal": { "description": "The used value (MiB) of the Local storage.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageControllerDrive": { "$ref": "#/components/schemas/storage.ControllerDrive.Relationship", "description": "A reference to a storageControllerDrive resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageFiles": { "description": "An array of relationships to storageFileItem resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.FileItem.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.Item.List": { "title": "List of 'storage.Item' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.Item' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.Item' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Item" }, "nullable": true } } } ] }, "storage.KeySetting": { "title": "Local Key Management", "description": "Models the security key configuration required for the drive security.", "x-allOf-name": "storage.KeySetting", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.KeySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.KeySetting" ], "default": "storage.KeySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.KeySetting" ], "default": "storage.KeySetting", "x-enum-as-string": true }, "KeyType": { "description": "Method to be used for fetching the security key.\n* `Kmip` - Remote security using KMIP.\n* `Manual` - Drive security using manual key.", "type": "string", "enum": [ "Kmip", "Manual" ], "default": "Kmip", "x-omitempty": true }, "ManualKey": { "description": "Manual key configuration.", "$ref": "#/components/schemas/storage.LocalKeySetting", "x-omitempty": true }, "RemoteKey": { "description": "Remote key security using KMIP configuration.", "$ref": "#/components/schemas/storage.RemoteKeySetting", "x-omitempty": true } } } ] }, "storage.KmipAuthCredentials": { "title": "KMIP Auth Credentials", "description": "Models the KMIP Server Authentication configuration to be able to connect and communicate from Endpoint.", "x-allOf-name": "storage.KmipAuthCredentials", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.KmipAuthCredentials', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.KmipAuthCredentials" ], "default": "storage.KmipAuthCredentials", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.KmipAuthCredentials" ], "default": "storage.KmipAuthCredentials", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "The password for the KMIP server login.", "type": "string", "pattern": "[!\"#%&'\\(\\)\\*\\+,\\-\\./:;<>@\\[\\\\\\]\\^_`\\{\\|\\}~a-zA-Z0-9]{0,80}", "writeOnly": true, "x-omitempty": true }, "UseAuthentication": { "description": "Enables/disables the authentication for communicating with KMIP server. This flag enables the authentication which makes authentication mandatory.", "type": "boolean", "x-omitempty": true }, "Username": { "description": "The user name for the KMIP server login.", "type": "string", "pattern": "^$|[a-zA-Z][a-zA-Z0-9_.-]{0,31}", "x-omitempty": true } } } ] }, "storage.KmipServer": { "title": "KMIP Server", "description": "Models the KMIP Server configuration used to fetch the drive security key.", "x-allOf-name": "storage.KmipServer", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.KmipServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.KmipServer" ], "default": "storage.KmipServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.KmipServer" ], "default": "storage.KmipServer", "x-enum-as-string": true }, "EnableDriveSecurity": { "description": "Enable the selected KMIP Server configuration for security. This flag just enables the drive security and only after remote key setting configured, the actual security will be applied.", "type": "boolean", "x-omitempty": true }, "IpAddress": { "description": "The IP address of the KMIP server. It could be an IPv4 address, an IPv6 address, or a hostname. Hostnames are valid only when Inband is configured for the CIMC address.", "type": "string", "x-omitempty": true }, "Port": { "description": "The port to which the KMIP client should connect.", "type": "integer", "format": "int64", "default": 5696, "minimum": 1024, "maximum": 65535, "x-omitempty": true }, "Timeout": { "description": "The timeout before which the KMIP client should connect.", "type": "integer", "format": "int64", "default": 60, "minimum": 1, "maximum": 250, "x-omitempty": true } } } ] }, "storage.KnoxSecureDriveConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'storage.KnoxSecureDriveConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.KnoxSecureDriveConfiguration' resources.", "x-one-of-name": "storage.KnoxSecureDriveConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.KnoxSecureDriveConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.KnoxSecureDriveConfiguration": { "title": "Knox Secure Drive Configuration", "description": "Object that stores Secure Drives Configuration data under a Server Profile, used for creation of secure vd, secure Jbod for Knox controller on reboot.", "x-allOf-name": "storage.KnoxSecureDriveConfiguration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.KnoxSecureDriveConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.KnoxSecureDriveConfiguration" ], "default": "storage.KnoxSecureDriveConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.KnoxSecureDriveConfiguration" ], "default": "storage.KnoxSecureDriveConfiguration", "x-enum-as-string": true }, "ControllerDn": { "description": "The storage controller Dn Name for which RAID is created at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerMoid": { "description": "The storage controller Moid for which RAID creation is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskStates": { "type": "array", "items": { "description": "Configuration of the secure JBOD along with encryption operation to apply at endpoint.", "$ref": "#/components/schemas/storage.InternalMoPhysicalDiskConfig", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DriveGroups": { "type": "array", "items": { "description": "Configuration of the RAID drive group to apply at endpoint.", "$ref": "#/components/schemas/storage.NvmeRaidDriveGroup", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ServerProfile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "StoragePolicy": { "$ref": "#/components/schemas/storage.StoragePolicy.Relationship", "description": "A reference to a storageStoragePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.KnoxSecureDriveConfiguration.List": { "title": "List of 'storage.KnoxSecureDriveConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.KnoxSecureDriveConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.KnoxSecureDriveConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.KnoxSecureDriveConfiguration" }, "nullable": true } } } ] }, "storage.LocalKeySetting": { "title": "Local Key Management", "description": "Models the local key configuration required for the drive security.", "x-allOf-name": "storage.LocalKeySetting", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.LocalKeySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.LocalKeySetting" ], "default": "storage.LocalKeySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.LocalKeySetting" ], "default": "storage.LocalKeySetting", "x-enum-as-string": true }, "ExistingKey": { "description": "Current Security Key Passphrase which is already configured on the server. From the security context, the passphrase should be at least 8 characters long and should include at least one uppercase letter, one lowercase letter, one number, and one special character.", "type": "string", "maxLength": 32, "writeOnly": true, "x-omitempty": true }, "IsExistingKeySet": { "description": "Indicates whether the value of the 'existingKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IsNewKeySet": { "description": "Indicates whether the value of the 'newKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "NewKey": { "description": "New Security Key Passphrase to be configured on the server. From the security context, the passphrase should be at least 8 characters long and should include at least one uppercase letter, one lowercase letter, one number, and one special character.", "type": "string", "pattern": "^$|^[a-zA-Z0-9=!&#$%+^@_*-]+$", "minLength": 8, "maxLength": 32, "writeOnly": true, "x-omitempty": true } } } ] }, "storage.M2VirtualDriveConfig": { "title": "Virtual Drive Configuration for M.2 RAID controller", "description": "This models the options for creating a virtual drive on M.2 RAID controller.", "x-allOf-name": "storage.M2VirtualDriveConfig", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.M2VirtualDriveConfig', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.M2VirtualDriveConfig" ], "default": "storage.M2VirtualDriveConfig", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.M2VirtualDriveConfig" ], "default": "storage.M2VirtualDriveConfig", "x-enum-as-string": true }, "ControllerSlot": { "description": "Select the M.2 RAID controller slot on which the virtual drive is to be created. Select 'MSTOR-RAID-1' to create virtual drive on the M.2 RAID controller in the first slot or in the MSTOR-RAID slot, 'MSTOR-RAID-2' for second slot, 'MSTOR-RAID-1, MSTOR-RAID-2' for both slots or either slot.\n* `MSTOR-RAID-1` - Virtual drive will be created on the M.2 RAID controller in the first slot.\n* `MSTOR-RAID-2` - Virtual drive will be created on the M.2 RAID controller in the second slot, if available.\n* `MSTOR-RAID-1,MSTOR-RAID-2` - Virtual drive will be created on the M.2 RAID controller in both the slots, if available.", "type": "string", "enum": [ "MSTOR-RAID-1", "MSTOR-RAID-2", "MSTOR-RAID-1,MSTOR-RAID-2" ], "default": "MSTOR-RAID-1", "x-omitempty": true }, "Enable": { "description": "If enabled, this will create a virtual drive on the M.2 RAID controller.", "type": "boolean", "default": false, "x-omitempty": true }, "Name": { "description": "The name of the virtual drive. The name can be between 1 and 15 alphanumeric characters. Spaces or any special characters other than - (hyphen) and _ (underscore) are not allowed. This field will be pre-populated with the default or user configured value which can be edited.", "type": "string", "default": "MStorBootVd", "pattern": "^[a-zA-Z0-9\\-_]*$", "maxLength": 15, "x-createOnly": true, "x-omitempty": true } } } ] }, "storage.ManualDriveGroup": { "title": "Storage:Manual Drive Group", "description": "This models the manual drive selection configuration.", "x-allOf-name": "storage.ManualDriveGroup", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.ManualDriveGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.ManualDriveGroup" ], "default": "storage.ManualDriveGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.ManualDriveGroup" ], "default": "storage.ManualDriveGroup", "x-enum-as-string": true }, "DedicatedHotSpares": { "description": "A collection of drives to be used as hot spares for this Drive Group.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "SpanGroups": { "type": "array", "items": { "description": "Enter list of Disk IDs separated by comma or hypen. Sample format is 1, 3 or 4-6, 8. Non spanned RAID levels like RAID0, RAID1, RAID5 and RAID6 expect a single group of disks whereas spanned RAID levels need multiple groups of disks with each group representing a span group. Non spanned RAID levels expect one span group and spanned RAID levels accept minimum 2 span groups and up to 8.", "$ref": "#/components/schemas/storage.SpanDrives", "x-createOnly": true, "x-omitempty": true }, "nullable": true } } } ] }, "storage.Namespace": { "title": "Storage:Namespace", "description": "The following properties related to a namespace created in the NVM subsystem are stored.", "x-allOf-name": "storage.Namespace", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Namespace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Namespace" ], "default": "storage.Namespace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Namespace" ], "default": "storage.Namespace", "x-enum-as-string": true }, "BlockCapacity": { "description": "Number of blocks of the namespace.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ByteFormatCapacity": { "description": "Capacity of the namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "LdevId": { "description": "LDEV number of the volume where the namespace is set.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NamespaceId": { "description": "ID of namespace created in the NVM subsystem.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NamespaceNickname": { "description": "Nickname of the namespace.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NamespacePath": { "title": "Storage:Namespace Path", "description": "The host-namespace path information (information related to the namespace and host NQN) is stored.", "x-allOf-name": "storage.NamespacePath", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NamespacePath', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NamespacePath" ], "default": "storage.NamespacePath", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NamespacePath" ], "default": "storage.NamespacePath", "x-enum-as-string": true }, "HostNqn": { "description": "Host NQN registered in the NVM subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "LdevId": { "description": "LDEV number of the volume where the namespace is set.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NamespaceId": { "description": "ID of namespace created in the NVM subsystem.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppAggregate.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppAggregate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppAggregate' resources.", "x-one-of-name": "storage.NetAppAggregate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppAggregate.Relationship": { "description": "A relationship to the 'storage.NetAppAggregate' resource, or the expanded 'storage.NetAppAggregate' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppAggregate.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppAggregate": { "title": "Storage:Net App Aggregate", "description": "NetApp aggregate is a collection of disks arranged into one or more RAID groups.", "x-allOf-name": "storage.NetAppAggregate", "allOf": [ { "$ref": "#/components/schemas/storage.BaseDiskPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppAggregate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppAggregate" ], "default": "storage.NetAppAggregate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppAggregate" ], "default": "storage.NetAppAggregate", "x-enum-as-string": true }, "AggregateType": { "description": "Storage disk type for NetApp aggregate.\n* `HDD` - Hard Disk Drive disk type.\n* `Hybrid` - Solid State Hard Disk Drive.\n* `Hybrid (Flash Pool)` - SSHD in a flash pool disk type.\n* `SSD` - Solid State Disk disk type.\n* `SSD (FabricPool)` - SSD in a flash pool disk type.\n* `VMDisk (SDS)` - Storage disk with Hard disk drive.\n* `VMDisk (FabricPool)` - Storage disk with Non-volatile random-access memory drives.\n* `LUN (FlexArray)` - LUN (FlexArray) disk type.\n* `Not Mapped` - Storage disk is not mapped.", "type": "string", "enum": [ "HDD", "Hybrid", "Hybrid (Flash Pool)", "SSD", "SSD (FabricPool)", "VMDisk (SDS)", "VMDisk (FabricPool)", "LUN (FlexArray)", "Not Mapped" ], "default": "HDD", "readOnly": true, "x-omitempty": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "CloudStorage": { "type": "array", "items": { "description": "Aggregates providing cloud storage.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "EfficiencyRatio": { "description": "Data reduction ratio (logical_used / used).", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of NetApp Aggregate across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeName": { "description": "The node name for the aggregate.", "type": "string", "readOnly": true, "x-omitempty": true }, "RaidSize": { "description": "Size of the RAID group represented by number of disks in the group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RaidType": { "description": "The RAID configuration type.\n* `Unknown` - Default unknown RAID type.\n* `RAID0` - RAID0 splits (\"stripes\") data evenly across two or more disks, without parity information.\n* `RAID1` - RAID1 requires a minimum of two disks to work, and provides data redundancy and failover.\n* `RAID4` - RAID4 stripes block level data and dedicates a disk to parity.\n* `RAID5` - RAID5 distributes striping and parity at a block level.\n* `RAID6` - RAID6 level operates like RAID5 with distributed parity and striping.\n* `RAID10` - RAID10 requires a minimum of four disks in the array. It stripes across disks for higher performance, and mirrors for redundancy.\n* `RAIDDP` - RAIDDP uses up to two spare disks to replace and reconstruct the data from up to two simultaneously failed disks within the RAID group.\n* `RAIDTEC` - With RAIDTEC protection, use up to three spare disks to replace and reconstruct the data from up to three simultaneously failed disks within the RAID group.", "type": "string", "enum": [ "Unknown", "RAID0", "RAID1", "RAID4", "RAID5", "RAID6", "RAID10", "RAIDDP", "RAIDTEC" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "State": { "description": "Current state of the NetApp aggregate.\n* `Unknown` - Specifies that the aggregate is discovered, but the aggregate information is not yet retrieved by the Unified Manager server.\n* `Online` - Aggregate is ready and available.\n* `Onlining` - The state is transitioning online.\n* `Offline` - Aggregate is unavailable.\n* `Offlining` - The state is transitioning offline.\n* `Relocating` - The aggregate is being relocated.\n* `Restricted` - Limited operations (e.g., parity reconstruction) are allowed, but data access is not allowed.\n* `Failed` - The aggregate cannot be brought online.\n* `Inconsistent` - The aggregate has been marked corrupted; contact technical support.\n* `Unmounted` - The aggregate is not mounted.", "type": "string", "enum": [ "Unknown", "Online", "Onlining", "Offline", "Offlining", "Relocating", "Restricted", "Failed", "Inconsistent", "Unmounted" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of NetApp Aggregate.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppAggregateEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppAggregate.List": { "title": "List of 'storage.NetAppAggregate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppAggregate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppAggregate' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate" }, "nullable": true } } } ] }, "storage.NetAppAggregateEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppAggregateEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppAggregateEvent' resources.", "x-one-of-name": "storage.NetAppAggregateEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppAggregateEvent.Relationship": { "description": "A relationship to the 'storage.NetAppAggregateEvent' resource, or the expanded 'storage.NetAppAggregateEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppAggregateEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppAggregateEvent": { "title": "Storage:Net App Aggregate Event", "description": "An event where the impacted resource type is an aggregate.", "x-allOf-name": "storage.NetAppAggregateEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppAggregateEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppAggregateEvent" ], "default": "storage.NetAppAggregateEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppAggregateEvent" ], "default": "storage.NetAppAggregateEvent", "x-enum-as-string": true }, "Aggregate": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.Relationship", "description": "A reference to a storageNetAppAggregate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppAggregateEvent.List": { "title": "List of 'storage.NetAppAggregateEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppAggregateEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppAggregateEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregateEvent" }, "nullable": true } } } ] }, "storage.NetAppAutoSupport": { "title": "Storage:Net App Auto Support", "description": "AutoSupport settings for the cluster.", "x-allOf-name": "storage.NetAppAutoSupport", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppAutoSupport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppAutoSupport" ], "default": "storage.NetAppAutoSupport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppAutoSupport" ], "default": "storage.NetAppAutoSupport", "x-enum-as-string": true }, "Enabled": { "description": "Specifies whether the AutoSupport daemon is enabled. When this setting is disabled, delivery of all AutoSupport messages is turned off.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "From": { "description": "The e-mail address from which the AutoSupport messages are sent.", "type": "string", "readOnly": true, "x-omitempty": true }, "ProxyUrl": { "description": "Proxy server for AutoSupport message delivery via HTTP/S.", "type": "string", "readOnly": true, "x-omitempty": true }, "Transport": { "description": "The name of the transport protocol used to deliver AutoSupport messages.\n* `none` - Default value of none when nothing is returned.\n* `smtp` - Simple Mail Transfer Protocol.\n* `http` - Hypertext Transfer Protocol.\n* `https` - Hypertext Transfer Protocol Secure.", "type": "string", "enum": [ "none", "smtp", "http", "https" ], "default": "none", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppBaseDisk.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppBaseDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppBaseDisk' resources.", "x-one-of-name": "storage.NetAppBaseDisk.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppBaseDisk.Relationship": { "description": "A relationship to the 'storage.NetAppBaseDisk' resource, or the expanded 'storage.NetAppBaseDisk' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppBaseDisk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppBaseDisk": { "title": "Storage:Net App Base Disk", "description": "NetApp base disk is a storage array disk.", "x-allOf-name": "storage.NetAppBaseDisk", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayDisk" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppBaseDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppBaseDisk" ], "default": "storage.NetAppBaseDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppBaseDisk" ], "default": "storage.NetAppBaseDisk", "x-enum-as-string": true }, "BaseDiskModel": { "description": "The NetApp base disk model.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterUuid": { "description": "Unique identity of the device.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "ContainerType": { "description": "Supported container type for NetApp disk.\n* `Unknown` - Default container type is currently unknown.\n* `Aggregate` - Disk is used as a physical disk in an aggregate.\n* `Broken` - Disk is in a broken pool.\n* `Label Maintenance` - Disk is in online label maintenance list.\n* `Foreign` - Array LUN has been marked foreign.\n* `Maintenance` - Disk is in maintenance center.\n* `Mediator` - A mediator disk is a disk used on non-shared HA systems hosted by an external node which is used to communicate the viability of the storage failover between non-shared HA nodes.\n* `Shared` - Disk is partitioned or in a storage pool.\n* `Remote` - Disk belongs to a remote cluster.\n* `Spare` - The disk is a spare disk.\n* `Unassigned` - Disk ownership has not been assigned.\n* `Unsupported` - The disk is not supported.", "type": "string", "enum": [ "Unknown", "Aggregate", "Broken", "Label Maintenance", "Foreign", "Maintenance", "Mediator", "Shared", "Remote", "Spare", "Unassigned", "Unsupported" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "DiskBay": { "description": "NetApp base disk shelf bay.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DiskSerialNumber": { "description": "NetApp base disk serial number.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskShelfId": { "description": "NetApp base disk shelf id.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskShelfModel": { "description": "NetApp base disk shelf model.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskShelfName": { "description": "NetApp base disk shelf name.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskType": { "description": "The type of the NetApp disk.\n* `Unknown` - Default unknown disk type.\n* `SSDNVM` - Solid state disk with Non-Volatile Memory Express protocol enabled.\n* `ATA` - Advanced Technology Attachment is a type of disk drive that integrates the drive controller directly on the drive itself.\n* `FCAL` - For the FC-AL disk connection type, disk shelves are connected to the controller in a loop.\n* `BSAS` - Bridged SAS-SATA disks with added hardware to enable them to be plugged into a SAS-connected storage shelf.\n* `FSAS` - Near Line SAS. NL-SAS drives are enterprise SATA drives with a SAS interface, head, media, and rotational speed of traditional enterprise-class SATA drives with the fully capable SAS interface typical for classic SAS drives.\n* `LUN` - Logical Unit Number refers to a logical disk.\n* `SAS` - Storage disk with serial attached SCSI.\n* `MSATA` - SATA disk in multi-disk carrier storage shelf.\n* `SSD` - Storage disk with Solid state disk.\n* `VMDISK` - Virtual machine Data Disk.", "type": "string", "enum": [ "Unknown", "SSDNVM", "ATA", "FCAL", "BSAS", "FSAS", "LUN", "SAS", "MSATA", "SSD", "VMDISK" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "NodeName": { "description": "The node name for the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "Current state of the NetApp disk.\n* `Present` - Storage disk state type is present.\n* `Copy` - Storage disk state type is copy.\n* `Broken` - Storage disk state type is broken.\n* `Maintenance` - Storage disk state type is maintenance.\n* `Partner` - Storage disk state type is partner.\n* `Pending` - Storage disk state type is pending.\n* `Reconstructing` - Storage disk state type is reconstructing.\n* `Removed` - Storage disk state type is removed.\n* `Spare` - Storage disk state type is spare.\n* `Unfail` - Storage disk state type is unfail.\n* `Zeroing` - Storage disk state type is zeroing.", "type": "string", "enum": [ "Present", "Copy", "Broken", "Maintenance", "Partner", "Pending", "Reconstructing", "Removed", "Spare", "Unfail", "Zeroing" ], "default": "Present", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the NetApp Disk.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DiskPool": { "description": "An array of relationships to storageNetAppAggregate resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.Relationship" }, "nullable": true, "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppDiskEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppBaseDisk.List": { "title": "List of 'storage.NetAppBaseDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppBaseDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppBaseDisk' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk" }, "nullable": true } } } ] }, "storage.NetAppBaseEvent": { "title": "Storage:Net App Base Event", "description": "An event is a notification that is generated automatically when a predefined condition occurs or when an object crosses a threshold.", "x-allOf-name": "storage.NetAppBaseEvent", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppBaseEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppAggregateEvent", "storage.NetAppClusterEvent", "storage.NetAppDataIpInterfaceEvent", "storage.NetAppDiskEvent", "storage.NetAppEthernetPortEvent", "storage.NetAppFcInterfaceEvent", "storage.NetAppFcPortEvent", "storage.NetAppIpInterfaceEvent", "storage.NetAppLunEvent", "storage.NetAppNodeEvent", "storage.NetAppNonDataIpInterfaceEvent", "storage.NetAppSvmEvent", "storage.NetAppVolumeEvent" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppAggregateEvent", "storage.NetAppClusterEvent", "storage.NetAppDataIpInterfaceEvent", "storage.NetAppDiskEvent", "storage.NetAppEthernetPortEvent", "storage.NetAppFcInterfaceEvent", "storage.NetAppFcPortEvent", "storage.NetAppIpInterfaceEvent", "storage.NetAppLunEvent", "storage.NetAppNodeEvent", "storage.NetAppNonDataIpInterfaceEvent", "storage.NetAppSvmEvent", "storage.NetAppVolumeEvent" ], "x-enum-as-string": true }, "Cause": { "description": "A message describing the cause for the event.", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterUuid": { "description": "Unique identifier of the cluster across the datacenter.", "type": "string", "readOnly": true, "x-omitempty": true }, "CurrentState": { "description": "The current state of the event.\n* `unknown` - Default unknown current state.\n* `new` - The current state of the event is new.\n* `acknowledged` - The current state of the event is acknowledged.\n* `resolved` - The current state of the event is resolved.\n* `obsolete` - The current state of the event is obsolete.", "type": "string", "enum": [ "unknown", "new", "acknowledged", "resolved", "obsolete" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "Duration": { "description": "Time since the event was created, in ISO8601 standard.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImpactArea": { "description": "Impact area of the event (availability, capacity, configuration, performance, protection, or security).\n* `unknown` - Default unknown impact area.\n* `availability` - The impact area of the event is availability.\n* `capacity` - The impact area of the event is capacity.\n* `configuration` - The impact area of the event is configuration.\n* `performance` - The impact area of the event is performance.\n* `protection` - The impact area of the event is protection.\n* `security` - The impact area of the event is security.", "type": "string", "enum": [ "unknown", "availability", "capacity", "configuration", "performance", "protection", "security" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "ImpactLevel": { "description": "Impact level of the event (event, risk, incident, or upgrade).\n* `unknown` - Default unknown impact level.\n* `event` - The impact level of the event is event.\n* `risk` - The impact level of the event is risk.\n* `incident` - The impact level of the event is incident.\n* `upgrade` - The impact level of the event is upgrade.", "type": "string", "enum": [ "unknown", "event", "risk", "incident", "upgrade" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "ImpactResourceName": { "description": "The full name of the source of the event.", "type": "string", "readOnly": true, "x-omitempty": true }, "ImpactResourceType": { "description": "Type of resource with which the event is associated.\n* `unknown` - Default unknown resource type.\n* `aggregate` - The type of resource impacted by the event is an aggregate.\n* `cluster` - The type of resource impacted by the event is a cluster.\n* `cluster_node` - The type of resource impacted by the event is a node.\n* `disk` - The type of resource impacted by the event is a disk.\n* `fcp_lif` - The type of resource impacted by the event is a FC interface.\n* `fcp_port` - The type of resource impacted by the event is a FC port.\n* `lun` - The type of resource impacted by the event is a lun.\n* `network_lif` - The type of resource impacted by the event is an ethernet interface.\n* `network_port` - The type of resource impacted by the event is an ethernet port.\n* `volume` - The type of resource impacted by the event is a volume.\n* `vserver` - The type of resource impacted by the event is a storage VM.", "type": "string", "enum": [ "unknown", "aggregate", "cluster", "cluster_node", "disk", "fcp_lif", "fcp_port", "lun", "network_lif", "network_port", "volume", "vserver" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "ImpactResourceUuid": { "description": "The unique identifier of the impacted resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the event that occurred.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeUuid": { "description": "Unique identifier of the node across the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "The severity of the event.\n* `unknown` - Default unknown severity.\n* `normal` - The severity of the event is normal.\n* `information` - The severity of the event is information.\n* `warning` - The severity of the event is warning.\n* `error` - The severity of the event is error.\n* `critical` - The severity of the event is critical.", "type": "string", "enum": [ "unknown", "normal", "information", "warning", "error", "critical" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "SvmUuid": { "description": "Unique identifier of the storage VM.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Unique identifier of the event.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppBaseIpInterface": { "title": "Storage:Net App Base Ip Interface", "description": "NetApp IP interface is a logical interface.", "x-allOf-name": "storage.NetAppBaseIpInterface", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppBaseIpInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppDataIpInterface", "storage.NetAppNonDataIpInterface" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppDataIpInterface", "storage.NetAppNonDataIpInterface" ], "x-enum-as-string": true }, "CurrentNode": { "description": "Name of the current node of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "CurrentPort": { "description": "Name of the current port of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "IP interface is enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomeNode": { "description": "Name of home node of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomePort": { "description": "Name of home port of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceIsHome": { "description": "Reports whether the IP interface is home or has failed over to its HA peer.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceState": { "description": "The state of the IP interface.\n* `Down` - The state is set to down if the interface is not enabled.\n* `Up` - The state is set to up if the interface is enabled.", "type": "string", "enum": [ "Down", "Up" ], "default": "Down", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "The IP address of interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpFamily": { "description": "IP address family of interface.\n* `IPv4` - IP address family type is IPv4.\n* `IPv6` - IP address family type is IP6.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "readOnly": true, "x-omitempty": true }, "Ipspace": { "description": "The name of the IPspace of the IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsHome": { "description": "Reports whether the IP interface is home or has failed over to its HA peer.", "deprecated": true, "x-sunset": "2027-03-01", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LocationFailover": { "description": "Defines where an interface may failover, [ home_port_only, default, home_node_only, sfo_partners_only, broadcast_domain_only ].", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Netmask": { "description": "The netmask of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServicePolicyName": { "description": "Service policy name of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServicePolicyUuid": { "description": "Service policy UUID of IP interface.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "Services of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "State": { "description": "The state of the IP interface.\n* `down` - An inactive port is listed as Down.\n* `up` - An active port is listed as Up.\n* `present` - An active port is listed as present.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "down", "up", "present" ], "default": "down", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of NetApp IP Interface.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppBaseSnapMirrorPolicy.Relationship": { "description": "A relationship to the 'storage.NetAppBaseSnapMirrorPolicy' resource, or the expanded 'storage.NetAppBaseSnapMirrorPolicy' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppBaseSnapMirrorPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapMirrorPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppBaseSnapMirrorPolicy": { "title": "Storage:Net App Base Snap Mirror Policy", "description": "NetApp SnapMirror policy when applied to a SnapMirror relationship, controls the behavior of the relationship and specifies the configuration attributes for that relationship.", "x-allOf-name": "storage.NetAppBaseSnapMirrorPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppBaseSnapMirrorPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppClusterSnapMirrorPolicy", "storage.NetAppSvmSnapMirrorPolicy" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppClusterSnapMirrorPolicy", "storage.NetAppSvmSnapMirrorPolicy" ], "x-enum-as-string": true }, "Comment": { "description": "Comment associated with the policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "CopyAllSourceSnapshots": { "description": "Specifies whether all source Snapshot copies should be copied to the destination on a transfer rather than specifying specific retentions. It is applicable only to async policies.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the NetApp SnapMirror policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "Identifies whether the SnapMirror policy is owned by the storage virtual machine or the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "SyncType": { "description": "SnapMirror policy sync_type is either sync, strict_sync, or automated_failover. Property is applicable only to the policies of type \"sync\".", "type": "string", "readOnly": true, "x-omitempty": true }, "TransferScheduleName": { "description": "Name of the schedule used to update asynchronous relationships.", "type": "string", "readOnly": true, "x-omitempty": true }, "TransferScheduleUuid": { "description": "Uuid of the schedule used to update asynchronous relationships.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Type": { "description": "SnapMirror policy type can be async, sync, or continuous.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of the NetApp SnapMirror policy.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppBaseSnapshotPolicy": { "title": "Storage:Net App Base Snapshot Policy", "description": "NetApp Snapshot policy controls the behavior and schedule of snapshots when applied to a volume.", "x-allOf-name": "storage.NetAppBaseSnapshotPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppBaseSnapshotPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppClusterSnapshotPolicy", "storage.NetAppSvmSnapshotPolicy" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.NetAppClusterSnapshotPolicy", "storage.NetAppSvmSnapshotPolicy" ], "x-enum-as-string": true }, "Copies": { "type": "array", "items": { "description": "Collection of NetApp Snapshot policy schedules that define the intervals at which Snapshot copies are created.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSnapshotPolicySchedule", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Enabled": { "description": "Snapshot policy is enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the NetApp Snapshot Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Scope": { "description": "Identifies whether the Snapshot Policy is owned by the Storage Virtual Machine or the cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of the NetApp Snapshot Policy.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppCifsAcl": { "title": "Storage:Net App Cifs Acl", "description": "Access Control List entry for the CIFS share.", "x-allOf-name": "storage.NetAppCifsAcl", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppCifsAcl', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppCifsAcl" ], "default": "storage.NetAppCifsAcl", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppCifsAcl" ], "default": "storage.NetAppCifsAcl", "x-enum-as-string": true }, "Permission": { "description": "Access rights that a user or group has on the defined CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of operating system for the CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true }, "UserOrGroup": { "description": "User or group name to add to the access control list of a CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppCifsService.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppCifsService' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppCifsService' resources.", "x-one-of-name": "storage.NetAppCifsService.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsService.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppCifsService": { "title": "Storage:Net App Cifs Service", "description": "NetApp CIFS service represents a CIFS server on a storage virtual machine.", "x-allOf-name": "storage.NetAppCifsService", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppCifsService', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppCifsService" ], "default": "storage.NetAppCifsService", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppCifsService" ], "default": "storage.NetAppCifsService", "x-enum-as-string": true }, "ActiveDirectoryFqdn": { "description": "The fully qualified domain name of the Windows Active Directory to which this CIFS server belongs.", "type": "string", "readOnly": true, "x-omitempty": true }, "AdOrganizationalUnit": { "description": "Identifies the organizational unit within the Active Directory domain to associate with the CIFS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Comment": { "description": "A descriptive text comment for the CIFS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Indicates that the CIFS service is administratively enabled.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerName": { "description": "Name of the NetApp CIFS server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the CIFS service.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmUuid": { "description": "Unique identifier for the NetApp Storage Virtual Machine.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppCifsService.List": { "title": "List of 'storage.NetAppCifsService' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppCifsService' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppCifsService' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsService" }, "nullable": true } } } ] }, "storage.NetAppCifsShare.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppCifsShare' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppCifsShare' resources.", "x-one-of-name": "storage.NetAppCifsShare.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsShare.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppCifsShare": { "title": "Storage:Net App Cifs Share", "description": "NetApp CIFS share is a named access point in a volume which is tied to the CIFS server on the SVM.", "x-allOf-name": "storage.NetAppCifsShare", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppCifsShare', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppCifsShare" ], "default": "storage.NetAppCifsShare", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppCifsShare" ], "default": "storage.NetAppCifsShare", "x-enum-as-string": true }, "Comment": { "description": "Description of the CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true }, "Encryption": { "description": "Indicates that SMB encryption must be used when accessing the share.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomeDirectory": { "description": "Indicates that the share is a home directory share, where the share and path names are dynamic.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the NetApp CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetAppCifsAcl": { "type": "array", "items": { "description": "Access Control List (ACL) defining the users and groups that have permissions to access the CIFS share.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsAcl", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Path": { "description": "The fully-qualified pathname in the owning SVM namespace that is shared through the share.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the CIFS share.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmUuid": { "description": "Unique identifier for the NetApp Storage Virtual Machine.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppCifsShare.List": { "title": "List of 'storage.NetAppCifsShare' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppCifsShare' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppCifsShare' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCifsShare" }, "nullable": true } } } ] }, "storage.NetAppCloudTarget.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppCloudTarget' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppCloudTarget' resources.", "x-one-of-name": "storage.NetAppCloudTarget.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCloudTarget.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppCloudTarget": { "title": "Storage:Net App Cloud Target", "description": "Cloud target is a collection of cloud provider configuration information for targets e.g., AWS_S3 or Azure_Cloud.", "x-allOf-name": "storage.NetAppCloudTarget", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppCloudTarget', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppCloudTarget" ], "default": "storage.NetAppCloudTarget", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppCloudTarget" ], "default": "storage.NetAppCloudTarget", "x-enum-as-string": true }, "AccessKey": { "description": "Access key ID for AWS_S3 and other S3 compatible provider types.", "type": "string", "readOnly": true, "x-omitempty": true }, "AuthenticationType": { "description": "Authentication used to access the target.", "type": "string", "readOnly": true, "x-omitempty": true }, "AzureAccount": { "description": "Azure cloud account name.", "type": "string", "readOnly": true, "x-omitempty": true }, "CapUrl": { "description": "Specifies a full URL of the request to a CAP server for retrieving temporary credentials (access-key, secret-password, and session token) for accessing the object store.", "type": "string", "readOnly": true, "x-omitempty": true }, "CertificateValidationEnabled": { "description": "Is SSL/TLS certificate validation enabled? The default value is true. This can only be modified for SGWS, IBM_COS, and ONTAP_S3 provider types.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "CloudStorage": { "type": "array", "items": { "description": "Configuration information for each cloud storage portion of the aggregate.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Container": { "description": "Data bucket/container name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Ipspace": { "description": "IPspace to use in order to reach the cloud target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the cloud target.", "type": "string", "readOnly": true, "x-omitempty": true }, "Owner": { "description": "Owner of the target. Allowed values are FabricPool or SnapMirror.\n* `FabricPool` - NetApp FabricPool Cloud Target owner.\n* `SnapMirror` - NetApp SnapMirror Cloud Target owner.", "type": "string", "enum": [ "FabricPool", "SnapMirror" ], "default": "FabricPool", "readOnly": true, "x-omitempty": true }, "Port": { "description": "Port number of the object store that ONTAP uses when establishing a connection.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ProviderType": { "description": "Type of cloud provider, e.g., AWS_S3 or ONTAP_S3.\n* `ONTAP_S3` - Cloud target provider type ONTAP_S3.\n* `AliCloud` - Cloud target provider type AliCloud.\n* `AWS_S3` - Cloud target provider type AWS S3.\n* `Azure_Cloud` - Cloud target provider type Azure_Cloud.\n* `GoogleCloud` - Cloud target provider type GoogleCloud.\n* `IBM_COS` - Cloud target provider type IBM_COS.\n* `SGWS` - Cloud target provider type SGWS.", "type": "string", "enum": [ "ONTAP_S3", "AliCloud", "AWS_S3", "Azure_Cloud", "GoogleCloud", "IBM_COS", "SGWS" ], "default": "ONTAP_S3", "readOnly": true, "x-omitempty": true }, "Server": { "description": "Fully qualified domain name of the object store server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapMirrorUse": { "description": "Use of the cloud target by SnapMirror.\n* `data` - Data is stored in the SnapMirror target.\n* `metadata` - Metadata is stored in the SnapMirror target.", "type": "string", "enum": [ "data", "metadata" ], "default": "data", "readOnly": true, "x-omitempty": true }, "SslEnabled": { "description": "SSL/HTTPS enabled or not.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Used": { "description": "The amount of cloud space used by all the aggregates attached to the target, in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of the cloud target.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppCloudTarget.List": { "title": "List of 'storage.NetAppCloudTarget' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppCloudTarget' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppCloudTarget' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCloudTarget" }, "nullable": true } } } ] }, "storage.NetAppCluster.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppCluster' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppCluster' resources.", "x-one-of-name": "storage.NetAppCluster.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppCluster.Relationship": { "description": "A relationship to the 'storage.NetAppCluster' resource, or the expanded 'storage.NetAppCluster' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppCluster.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppCluster": { "title": "Storage:Net App Cluster", "description": "The NetAppCluster object is a pivotal component within storage systems, representing a unified collection of nodes that function together as a scalable entity. This encapsulates the core characteristics and operational aspects of a storage cluster, providing a comprehensive framework for managing and monitoring cluster-level resources and activities.\n#### Purpose\nA NetAppCluster serves as the central entity for storage management, integrating multiple nodes to deliver high availability, performance, and capacity management. It acts as a control point for orchestrating storage operations, facilitating seamless data management across nodes within the cluster.\n#### Key Concepts\n- **Scalability:** NetAppCluster supports the expansion of storage resources by adding nodes, enabling dynamic growth and increased capacity.\n- **High Availability:** Ensures continuous operation and data accessibility, even during node failures, through integrated failover and redundancy mechanisms.\n- **Performance Optimization:** Utilizes advanced algorithms to balance workloads across nodes, enhancing throughput and minimizing latency.\n- **Unified Management:** Provides a centralized interface for configuring, monitoring, and managing all aspects of the cluster, streamlining administrative tasks and reducing complexity.", "x-allOf-name": "storage.NetAppCluster", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArray" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppCluster', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppCluster" ], "default": "storage.NetAppCluster", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppCluster" ], "default": "storage.NetAppCluster", "x-enum-as-string": true }, "AutoSupport": { "description": "AutoSupport configuration of the cluster.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAutoSupport", "readOnly": true, "x-omitempty": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "ClusterEfficiency": { "description": "Cluster storage efficiency savings, ratio, and logical used.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageClusterEfficiency", "readOnly": true, "x-omitempty": true }, "ClusterHealthStatus": { "description": "The health status of the cluster. Possible states are ok, ok-with-suppressed, degraded, and unreachable.\n* `Unreachable` - Cluster status is unreachable.\n* `OK` - Cluster status is either ok or ok-with-suppressed.\n* `Degraded` - Cluster status is degraded.", "type": "string", "enum": [ "Unreachable", "OK", "Degraded" ], "default": "Unreachable", "readOnly": true, "x-omitempty": true }, "DefaultAdminLocked": { "description": "Indicates whether the default admin user is locked out.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DnsDomains": { "type": "array", "items": { "description": "A list of Domain Name System ( DNS ) domains.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FipsCompliant": { "description": "Indicates whether or not the software FIPS mode is enabled on the cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "InsecureCiphers": { "description": "Number of SVMs on the cluster that use insecure ciphers.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of NetApp Cluster across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "Location": { "description": "Location of the storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "ManagementAddress": { "type": "array", "items": { "description": "IP Addresses of Storage Cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NameServers": { "type": "array", "items": { "description": "The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NtpServers": { "type": "array", "items": { "description": "Host name, IPv4 address, or IPv6 address for the external NTP time servers.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RshEnabled": { "description": "Indicates whether or not rsh is enabled on the cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "TelnetEnabled": { "description": "Indicates whether or not telnet is enabled on the cluster.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "VersionGeneration": { "description": "The generation portion of the version.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VersionMajor": { "description": "The major portion of the version.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VersionMinor": { "description": "The minor portion of the version.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Events": { "description": "An array of relationships to storageNetAppClusterEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppCluster.List": { "title": "List of 'storage.NetAppCluster' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppCluster' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppCluster' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster" }, "nullable": true } } } ] }, "storage.NetAppClusterEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppClusterEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppClusterEvent' resources.", "x-one-of-name": "storage.NetAppClusterEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppClusterEvent.Relationship": { "description": "A relationship to the 'storage.NetAppClusterEvent' resource, or the expanded 'storage.NetAppClusterEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppClusterEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppClusterEvent": { "title": "Storage:Net App Cluster Event", "description": "An event where the impacted resource type is a cluster.", "x-allOf-name": "storage.NetAppClusterEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppClusterEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppClusterEvent" ], "default": "storage.NetAppClusterEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppClusterEvent" ], "default": "storage.NetAppClusterEvent", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppClusterEvent.List": { "title": "List of 'storage.NetAppClusterEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppClusterEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppClusterEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterEvent" }, "nullable": true } } } ] }, "storage.NetAppClusterSnapMirrorPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppClusterSnapMirrorPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppClusterSnapMirrorPolicy' resources.", "x-one-of-name": "storage.NetAppClusterSnapMirrorPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapMirrorPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppClusterSnapMirrorPolicy": { "title": "Storage:Net App Cluster Snap Mirror Policy", "description": "NetApp SnapMirror policy owned by the cluster. NetApp SnapMirror policy when applied to a SnapMirror relationship, controls the behavior of the relationship and specifies the configuration attributes for that relationship.", "x-allOf-name": "storage.NetAppClusterSnapMirrorPolicy", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapMirrorPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppClusterSnapMirrorPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppClusterSnapMirrorPolicy" ], "default": "storage.NetAppClusterSnapMirrorPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppClusterSnapMirrorPolicy" ], "default": "storage.NetAppClusterSnapMirrorPolicy", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppClusterSnapMirrorPolicy.List": { "title": "List of 'storage.NetAppClusterSnapMirrorPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppClusterSnapMirrorPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppClusterSnapMirrorPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapMirrorPolicy" }, "nullable": true } } } ] }, "storage.NetAppClusterSnapshotPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppClusterSnapshotPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppClusterSnapshotPolicy' resources.", "x-one-of-name": "storage.NetAppClusterSnapshotPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapshotPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppClusterSnapshotPolicy": { "title": "Storage:Net App Cluster Snapshot Policy", "description": "NetApp Snapshot policy that is scoped to a cluster. The policy controls the behavior and schedule of snapshots when applied to a volume.", "x-allOf-name": "storage.NetAppClusterSnapshotPolicy", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapshotPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppClusterSnapshotPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppClusterSnapshotPolicy" ], "default": "storage.NetAppClusterSnapshotPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppClusterSnapshotPolicy" ], "default": "storage.NetAppClusterSnapshotPolicy", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppClusterSnapshotPolicy.List": { "title": "List of 'storage.NetAppClusterSnapshotPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppClusterSnapshotPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppClusterSnapshotPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppClusterSnapshotPolicy" }, "nullable": true } } } ] }, "storage.NetAppDataIpInterface.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppDataIpInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppDataIpInterface' resources.", "x-one-of-name": "storage.NetAppDataIpInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppDataIpInterface.Relationship": { "description": "A relationship to the 'storage.NetAppDataIpInterface' resource, or the expanded 'storage.NetAppDataIpInterface' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppDataIpInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppDataIpInterface": { "title": "Storage:Net App Data Ip Interface", "description": "NetApp Data IP interface is a logical interface for data within the svm scope.", "x-allOf-name": "storage.NetAppDataIpInterface", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseIpInterface" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppDataIpInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppDataIpInterface" ], "default": "storage.NetAppDataIpInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppDataIpInterface" ], "default": "storage.NetAppDataIpInterface", "x-enum-as-string": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppDataIpInterfaceEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent.Relationship" }, "nullable": true, "readOnly": true }, "NetAppEthernetPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.Relationship", "description": "A reference to a storageNetAppEthernetPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppDataIpInterface.List": { "title": "List of 'storage.NetAppDataIpInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppDataIpInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppDataIpInterface' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface" }, "nullable": true } } } ] }, "storage.NetAppDataIpInterfaceEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppDataIpInterfaceEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppDataIpInterfaceEvent' resources.", "x-one-of-name": "storage.NetAppDataIpInterfaceEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppDataIpInterfaceEvent.Relationship": { "description": "A relationship to the 'storage.NetAppDataIpInterfaceEvent' resource, or the expanded 'storage.NetAppDataIpInterfaceEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppDataIpInterfaceEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppDataIpInterfaceEvent": { "title": "Storage:Net App Data Ip Interface Event", "description": "An event where the impacted resource type is an ip interface.", "x-allOf-name": "storage.NetAppDataIpInterfaceEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppDataIpInterfaceEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppDataIpInterfaceEvent" ], "default": "storage.NetAppDataIpInterfaceEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppDataIpInterfaceEvent" ], "default": "storage.NetAppDataIpInterfaceEvent", "x-enum-as-string": true }, "IpInterface": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterface.Relationship", "description": "A reference to a storageNetAppDataIpInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppDataIpInterfaceEvent.List": { "title": "List of 'storage.NetAppDataIpInterfaceEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppDataIpInterfaceEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppDataIpInterfaceEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDataIpInterfaceEvent" }, "nullable": true } } } ] }, "storage.NetAppDiskEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppDiskEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppDiskEvent' resources.", "x-one-of-name": "storage.NetAppDiskEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppDiskEvent.Relationship": { "description": "A relationship to the 'storage.NetAppDiskEvent' resource, or the expanded 'storage.NetAppDiskEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppDiskEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppDiskEvent": { "title": "Storage:Net App Disk Event", "description": "An event where the impacted resource type is a disk.", "x-allOf-name": "storage.NetAppDiskEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppDiskEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppDiskEvent" ], "default": "storage.NetAppDiskEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppDiskEvent" ], "default": "storage.NetAppDiskEvent", "x-enum-as-string": true }, "Disk": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseDisk.Relationship", "description": "A reference to a storageNetAppBaseDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppDiskEvent.List": { "title": "List of 'storage.NetAppDiskEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppDiskEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppDiskEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppDiskEvent" }, "nullable": true } } } ] }, "storage.NetAppEthernetPort.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppEthernetPort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppEthernetPort' resources.", "x-one-of-name": "storage.NetAppEthernetPort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppEthernetPort.Relationship": { "description": "A relationship to the 'storage.NetAppEthernetPort' resource, or the expanded 'storage.NetAppEthernetPort' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppEthernetPort.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppEthernetPort": { "title": "Storage:Net App Ethernet Port", "description": "Ethernet port is a port on a node in a storage array.", "x-allOf-name": "storage.NetAppEthernetPort", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppEthernetPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppEthernetPort" ], "default": "storage.NetAppEthernetPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppEthernetPort" ], "default": "storage.NetAppEthernetPort", "x-enum-as-string": true }, "BroadcastDomainName": { "description": "Name of the broadcast domain, scoped to its IPspace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Status of port to determine if its enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "MAC address of the port available in storage array.", "type": "string", "pattern": "^$|^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$", "readOnly": true, "x-omitempty": true }, "Mtu": { "description": "Maximum transmission unit of the physical port available in storage array.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the port available in storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "NetAppEthernetPortLag": { "description": "Storage port of type lag.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortLag", "readOnly": true, "x-omitempty": true }, "NetAppEthernetPortVlan": { "description": "A logical port that receives and sends VLAN-tagged (IEEE 802.1Q standard) traffic. VLAN port characteristics include the VLAN ID for the port.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortVlan", "readOnly": true, "x-omitempty": true }, "NodeName": { "description": "The node name for the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortState": { "description": "State of the port available in storage array.\n* `Down` - An inactive port is listed as Down.\n* `Up` - An active port is listed as Up.\n* `Degraded` - An active port that is Up but unhealthy.", "type": "string", "enum": [ "Down", "Up", "Degraded" ], "default": "Down", "readOnly": true, "x-omitempty": true }, "Speed": { "description": "Operational speed of port measured.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "State": { "description": "State of the port available in storage array.\n* `down` - An inactive port is listed as Down.\n* `up` - An active port is listed as Up.\n* `present` - An active port is listed as present.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "down", "up", "present" ], "default": "down", "readOnly": true, "x-omitempty": true }, "Type": { "description": "Type of the port available in storage array.\n* `LAG` - Storage port of type lag.\n* `physical` - LIFs can be configured directly on physical ports.\n* `VLAN` - A logical port that receives and sends VLAN-tagged (IEEE 802.1Q standard) traffic. VLAN port characteristics include the VLAN ID for the port.", "type": "string", "enum": [ "LAG", "physical", "VLAN" ], "default": "LAG", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the physical port.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppEthernetPortEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppEthernetPort.List": { "title": "List of 'storage.NetAppEthernetPort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppEthernetPort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppEthernetPort' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort" }, "nullable": true } } } ] }, "storage.NetAppEthernetPortEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppEthernetPortEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppEthernetPortEvent' resources.", "x-one-of-name": "storage.NetAppEthernetPortEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppEthernetPortEvent.Relationship": { "description": "A relationship to the 'storage.NetAppEthernetPortEvent' resource, or the expanded 'storage.NetAppEthernetPortEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppEthernetPortEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppEthernetPortEvent": { "title": "Storage:Net App Ethernet Port Event", "description": "An event where the impacted resource type is an ethernet port.", "x-allOf-name": "storage.NetAppEthernetPortEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppEthernetPortEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppEthernetPortEvent" ], "default": "storage.NetAppEthernetPortEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppEthernetPortEvent" ], "default": "storage.NetAppEthernetPortEvent", "x-enum-as-string": true }, "EthernetPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.Relationship", "description": "A reference to a storageNetAppEthernetPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppEthernetPortEvent.List": { "title": "List of 'storage.NetAppEthernetPortEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppEthernetPortEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppEthernetPortEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPortEvent" }, "nullable": true } } } ] }, "storage.NetAppEthernetPortLag": { "title": "Storage:Net App Ethernet Port Lag", "description": "Storage port of type lag.", "x-allOf-name": "storage.NetAppEthernetPortLag", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppEthernetPortLag', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppEthernetPortLag" ], "default": "storage.NetAppEthernetPortLag", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppEthernetPortLag" ], "default": "storage.NetAppEthernetPortLag", "x-enum-as-string": true }, "ActivePorts": { "type": "array", "items": { "description": "Active ports of a LAG (ifgrp). Some member ports may be inactive.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPort", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DistributionPolicy": { "description": "Policy for mapping flows to ports for outbound packets through a LAG (ifgrp).\n* `none` - Default unknown distribution policy type.\n* `port` - Network traffic is distributed based on the transport layer (TCP/UDP) ports.\n* `ip` - Network traffic is distributed based on IP addresses.\n* `mac` - Network traffic is distributed based on MAC addresses.\n* `sequential` - Network traffic is distributed in round-robin fashion from the list of configured, available ports.", "type": "string", "enum": [ "none", "port", "ip", "mac", "sequential" ], "default": "none", "readOnly": true, "x-omitempty": true }, "MemberPorts": { "type": "array", "items": { "description": "Port UUID along with readable names.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPort", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Mode": { "description": "Determines how the ports interact with the switch.\n* `none` - Default unknown lag mode type.\n* `multimode_lacp` - Bundle multiple member ports of the interface group using Link Aggregation Control Protocol.\n* `multimode` - Bundle multiple member ports of the interface group to act as a single trunked port.\n* `singlemode` - Provide port redundancy using member ports of the interface group for failover.", "type": "string", "enum": [ "none", "multimode_lacp", "multimode", "singlemode" ], "default": "none", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppEthernetPortVlan": { "title": "Storage:Net App Ethernet Port Vlan", "description": "A logical port that receives and sends VLAN-tagged (IEEE 802.1Q standard) traffic. VLAN port characteristics include the VLAN ID for the port.", "x-allOf-name": "storage.NetAppEthernetPortVlan", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppEthernetPortVlan', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppEthernetPortVlan" ], "default": "storage.NetAppEthernetPortVlan", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppEthernetPortVlan" ], "default": "storage.NetAppEthernetPortVlan", "x-enum-as-string": true }, "BasePort": { "description": "Port UUID along with readable names.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPort", "readOnly": true, "x-omitempty": true }, "Tag": { "description": "The ID tag of the VLAN for this port.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppExportPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppExportPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppExportPolicy' resources.", "x-one-of-name": "storage.NetAppExportPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppExportPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppExportPolicy": { "title": "Storage:Net App Export Policy", "description": "NetApp export policies enable client access control to volumes. Clients that match specific IP addresses and/or specific authentication types are granted access.", "x-allOf-name": "storage.NetAppExportPolicy", "allOf": [ { "$ref": "#/components/schemas/storage.BaseNfsExport" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppExportPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppExportPolicy" ], "default": "storage.NetAppExportPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppExportPolicy" ], "default": "storage.NetAppExportPolicy", "x-enum-as-string": true }, "ClusterUuid": { "description": "Unique identity of the device.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "NetAppExportPolicyRule": { "type": "array", "items": { "description": "ID for the Export Policy.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppExportPolicyRule", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PolicyId": { "description": "ID for the Export Policy.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppExportPolicy.List": { "title": "List of 'storage.NetAppExportPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppExportPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppExportPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppExportPolicy" }, "nullable": true } } } ] }, "storage.NetAppExportPolicyRule": { "title": "Storage:Net App Export Policy Rule", "description": "NetApp export rules are the functional elements of an export policy. Export rules match client access requests to a volume against specific parameters you configure to determine how to handle the client access requests.", "x-allOf-name": "storage.NetAppExportPolicyRule", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppExportPolicyRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppExportPolicyRule" ], "default": "storage.NetAppExportPolicyRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppExportPolicyRule" ], "default": "storage.NetAppExportPolicyRule", "x-enum-as-string": true }, "ClientMatch": { "type": "array", "items": { "description": "Client matches defined in NetApp export policy rules.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Index": { "description": "Position of export rule in the list of rules.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Protocols": { "type": "array", "items": { "description": "Export policy access protocols.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RoRule": { "type": "array", "items": { "description": "Read-only rule defined in the export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "RwRule": { "type": "array", "items": { "description": "Read-write rule defined in the export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SuperUser": { "type": "array", "items": { "description": "Export policy rule that has the specified superuser security type.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "User": { "description": "Export Policy rule that are mapped to this User ID.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppFcInterface.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppFcInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppFcInterface' resources.", "x-one-of-name": "storage.NetAppFcInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppFcInterface.Relationship": { "description": "A relationship to the 'storage.NetAppFcInterface' resource, or the expanded 'storage.NetAppFcInterface' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppFcInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppFcInterface": { "title": "Storage:Net App Fc Interface", "description": "NetApp FC Interface is a logical interface.", "x-allOf-name": "storage.NetAppFcInterface", "allOf": [ { "$ref": "#/components/schemas/storage.BasePhysicalPort" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppFcInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppFcInterface" ], "default": "storage.NetAppFcInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppFcInterface" ], "default": "storage.NetAppFcInterface", "x-enum-as-string": true }, "Enabled": { "description": "FC interface is enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "InterfaceState": { "description": "The state of the FC interface.\n* `Down` - The state is set to down if the interface is not enabled.\n* `Up` - The state is set to up if the interface is enabled.", "type": "string", "enum": [ "Down", "Up" ], "default": "Down", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of the FC interface.\n* `down` - An inactive port is listed as Down.\n* `up` - An active port is listed as Up.\n* `present` - An active port is listed as present.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "enum": [ "down", "up", "present" ], "default": "down", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of NetApp FC Interface.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "The parent volume name for the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppFcInterfaceEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent.Relationship" }, "nullable": true, "readOnly": true }, "PhysicalPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort.Relationship", "description": "A reference to a storageNetAppFcPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppFcInterface.List": { "title": "List of 'storage.NetAppFcInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppFcInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppFcInterface' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface" }, "nullable": true } } } ] }, "storage.NetAppFcInterfaceEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppFcInterfaceEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppFcInterfaceEvent' resources.", "x-one-of-name": "storage.NetAppFcInterfaceEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppFcInterfaceEvent.Relationship": { "description": "A relationship to the 'storage.NetAppFcInterfaceEvent' resource, or the expanded 'storage.NetAppFcInterfaceEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppFcInterfaceEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppFcInterfaceEvent": { "title": "Storage:Net App Fc Interface Event", "description": "An event where the impacted resource type is a FC interface.", "x-allOf-name": "storage.NetAppFcInterfaceEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppFcInterfaceEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppFcInterfaceEvent" ], "default": "storage.NetAppFcInterfaceEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppFcInterfaceEvent" ], "default": "storage.NetAppFcInterfaceEvent", "x-enum-as-string": true }, "FcInterface": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterface.Relationship", "description": "A reference to a storageNetAppFcInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppFcInterfaceEvent.List": { "title": "List of 'storage.NetAppFcInterfaceEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppFcInterfaceEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppFcInterfaceEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcInterfaceEvent" }, "nullable": true } } } ] }, "storage.NetAppFcPort.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppFcPort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppFcPort' resources.", "x-one-of-name": "storage.NetAppFcPort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppFcPort.Relationship": { "description": "A relationship to the 'storage.NetAppFcPort' resource, or the expanded 'storage.NetAppFcPort' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppFcPort.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppFcPort": { "title": "Storage:Net App Fc Port", "description": "Fibre Channel (FC) port is a port on a node in a storage array.", "x-allOf-name": "storage.NetAppFcPort", "allOf": [ { "$ref": "#/components/schemas/storage.BasePhysicalPort" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppFcPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppFcPort" ], "default": "storage.NetAppFcPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppFcPort" ], "default": "storage.NetAppFcPort", "x-enum-as-string": true }, "NodeName": { "description": "The node name for the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "PortStatus": { "description": "Status of storage array port.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpeedConfigured": { "description": "The configured speed of the FC port in gigabits per second.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpeedMaximum": { "description": "The maximum speed supported by the FC port in gigabits per second.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State of the port available in storage array.\n* `Unknown` - Default unknown port state.\n* `StartUp` - The port in the storage array is booting up.\n* `LinkNotConnected` - The port has finished initialization, but a link with the fabric is not established.\n* `Online` - The port is initialized and a link with the fabric has been established.\n* `LinkDisconnected` - The link on this port is currently not established.\n* `OfflineUser` - The port is administratively disabled.\n* `OfflineSystem` - The port is set to offline by the system. This happens when the port encounters too many errors.\n* `NodeOffline` - The state information for the port cannot be retrieved. The node is offline or inaccessible.", "type": "string", "enum": [ "Unknown", "StartUp", "LinkNotConnected", "Online", "LinkDisconnected", "OfflineUser", "OfflineSystem", "NodeOffline" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the FC port.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppFcPortEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppFcPort.List": { "title": "List of 'storage.NetAppFcPort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppFcPort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppFcPort' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort" }, "nullable": true } } } ] }, "storage.NetAppFcPortEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppFcPortEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppFcPortEvent' resources.", "x-one-of-name": "storage.NetAppFcPortEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppFcPortEvent.Relationship": { "description": "A relationship to the 'storage.NetAppFcPortEvent' resource, or the expanded 'storage.NetAppFcPortEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppFcPortEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppFcPortEvent": { "title": "Storage:Net App Fc Port Event", "description": "An event where the impacted resource type is a FC port.", "x-allOf-name": "storage.NetAppFcPortEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppFcPortEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppFcPortEvent" ], "default": "storage.NetAppFcPortEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppFcPortEvent" ], "default": "storage.NetAppFcPortEvent", "x-enum-as-string": true }, "FcPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPort.Relationship", "description": "A reference to a storageNetAppFcPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppFcPortEvent.List": { "title": "List of 'storage.NetAppFcPortEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppFcPortEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppFcPortEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppFcPortEvent" }, "nullable": true } } } ] }, "storage.NetAppHighAvailability": { "title": "Storage:Net App High Availability", "description": "Storage failover and giveback information.", "x-allOf-name": "storage.NetAppHighAvailability", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppHighAvailability', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppHighAvailability" ], "default": "storage.NetAppHighAvailability", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppHighAvailability" ], "default": "storage.NetAppHighAvailability", "x-enum-as-string": true }, "AutoGivebackEnabled": { "description": "Specifies whether or not giveback is automatically initiated when the node that owns the storage is ready.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Specifies whether or not storage failover is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "GivebackState": { "description": "The state of the node that is giving storage back to its HA partner.\n* `unknown` - Default unknown giveback state.\n* `nothing_to_giveback` - The node has nothing to give back to its HA partner.\n* `not_attempted` - The node has not attempted to give back storage to its HA partner.\n* `in_progress` - The node is in progress of giving back storage to its HA partner.\n* `failed` - The node has failed to give back storage to its HA partner.", "type": "string", "enum": [ "unknown", "nothing_to_giveback", "not_attempted", "in_progress", "failed" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "PartnerModel": { "description": "The model of the partner in this node's High Availability (HA) group.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartnerName": { "description": "The partner node name in this node's High Availability (HA) group.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartnerUuid": { "description": "The partner node uuid in this node's High Availability (HA) group.", "type": "string", "readOnly": true, "x-omitempty": true }, "TakeoverState": { "description": "The state of the node that is taking over storage from its HA partner.\n* `unknown` - Default unknown takeover state.\n* `not_possible` - It is not possible for the node to take over storage from its HA partner.\n* `not_attempted` - The node has not attempted to take over storage from its HA partner.\n* `in_takeover` - The node has taken over storage from its HA partner.\n* `in_progress` - The node is in progress of taking over storage from its HA partner.\n* `failed` - The node has failed to take over storage from its HA partner.", "type": "string", "enum": [ "unknown", "not_possible", "not_attempted", "in_takeover", "in_progress", "failed" ], "default": "unknown", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppInitiatorGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppInitiatorGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppInitiatorGroup' resources.", "x-one-of-name": "storage.NetAppInitiatorGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppInitiatorGroup.Relationship": { "description": "A relationship to the 'storage.NetAppInitiatorGroup' resource, or the expanded 'storage.NetAppInitiatorGroup' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppInitiatorGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppInitiatorGroup": { "title": "Storage:Net App Initiator Group", "description": "NetApp Initiator Group specifies host access to LUNs on the storage system.", "x-allOf-name": "storage.NetAppInitiatorGroup", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHost" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppInitiatorGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppInitiatorGroup" ], "default": "storage.NetAppInitiatorGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppInitiatorGroup" ], "default": "storage.NetAppInitiatorGroup", "x-enum-as-string": true }, "Protocol": { "description": "Initiator group protocol.\n* `FCP` - Fibre channel initiator type which contains WWN of an HBA on the host.\n* `iSCSI` - An iSCSI initiator type used by the host.\n* `mixed` - For systems using both FC and iSCSI connections to the same LUN, create two igroups, one for FC and one for iSCSI. Then map the LUN to both igroups.", "type": "string", "enum": [ "FCP", "iSCSI", "mixed" ], "default": "FCP", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the initiator group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the LUN.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppInitiatorGroup.List": { "title": "List of 'storage.NetAppInitiatorGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppInitiatorGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppInitiatorGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup" }, "nullable": true } } } ] }, "storage.NetAppIpInterface.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppIpInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppIpInterface' resources.", "x-one-of-name": "storage.NetAppIpInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppIpInterface.Relationship": { "description": "A relationship to the 'storage.NetAppIpInterface' resource, or the expanded 'storage.NetAppIpInterface' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppIpInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppIpInterface": { "title": "Storage:Net App Ip Interface", "description": "NetApp IP interface is a logical interface.", "x-allOf-name": "storage.NetAppIpInterface", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppIpInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppIpInterface" ], "default": "storage.NetAppIpInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppIpInterface" ], "default": "storage.NetAppIpInterface", "x-enum-as-string": true }, "Enabled": { "description": "IP interface is enabled or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomeNode": { "description": "Name of home node of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "HomePort": { "description": "Name of home port of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpAddress": { "description": "The IP address of interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "IpFamily": { "description": "IP address family of interface.\n* `IPv4` - IP address family type is IPv4.\n* `IPv6` - IP address family type is IP6.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Netmask": { "description": "The netmask of the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServicePolicyName": { "description": "Service policy name of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServicePolicyUuid": { "description": "Service policy UUID of IP interface.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Services": { "type": "array", "items": { "description": "Services of IP interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "State": { "description": "The state of the IP interface.\n* `down` - An inactive port is listed as Down.\n* `up` - An active port is listed as Up.\n* `present` - An active port is listed as present.", "type": "string", "enum": [ "down", "up", "present" ], "default": "down", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of NetApp IP Interface.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppIpInterfaceEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent.Relationship" }, "nullable": true, "readOnly": true }, "NetAppEthernetPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.Relationship", "description": "A reference to a storageNetAppEthernetPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppIpInterface.List": { "title": "List of 'storage.NetAppIpInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppIpInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppIpInterface' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface" }, "nullable": true } } } ] }, "storage.NetAppIpInterfaceEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppIpInterfaceEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppIpInterfaceEvent' resources.", "x-one-of-name": "storage.NetAppIpInterfaceEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppIpInterfaceEvent.Relationship": { "description": "A relationship to the 'storage.NetAppIpInterfaceEvent' resource, or the expanded 'storage.NetAppIpInterfaceEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppIpInterfaceEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppIpInterfaceEvent": { "title": "Storage:Net App Ip Interface Event", "description": "An event where the impacted resource type is an ip interface.", "x-allOf-name": "storage.NetAppIpInterfaceEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppIpInterfaceEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppIpInterfaceEvent" ], "default": "storage.NetAppIpInterfaceEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppIpInterfaceEvent" ], "default": "storage.NetAppIpInterfaceEvent", "x-enum-as-string": true }, "IpInterface": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterface.Relationship", "description": "A reference to a storageNetAppIpInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppIpInterfaceEvent.List": { "title": "List of 'storage.NetAppIpInterfaceEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppIpInterfaceEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppIpInterfaceEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIpInterfaceEvent" }, "nullable": true } } } ] }, "storage.NetAppIscsiService.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppIscsiService' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppIscsiService' resources.", "x-one-of-name": "storage.NetAppIscsiService.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIscsiService.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppIscsiService": { "title": "Storage:Net App Iscsi Service", "description": "An iSCSI service defines the properties of the iSCSI target for an SVM. There can be at most one iSCSI service for an SVM. An SVM's iSCSI service must be created before iSCSI initiators can log in to the SVM.", "x-allOf-name": "storage.NetAppIscsiService", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppIscsiService', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppIscsiService" ], "default": "storage.NetAppIscsiService", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppIscsiService" ], "default": "storage.NetAppIscsiService", "x-enum-as-string": true }, "SvmUuid": { "description": "Unique identifier for the NetApp Storage Virtual Machine.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "TargetAlias": { "description": "The iSCSI target alias of the iSCSI service.", "type": "string", "readOnly": true, "x-omitempty": true }, "TargetName": { "description": "The iSCSI target name of the iSCSI service.", "type": "string", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppIscsiService.List": { "title": "List of 'storage.NetAppIscsiService' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppIscsiService' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppIscsiService' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppIscsiService" }, "nullable": true } } } ] }, "storage.NetAppLicense.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppLicense' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppLicense' resources.", "x-one-of-name": "storage.NetAppLicense.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLicense.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppLicense": { "title": "Storage:Net App License", "description": "NetApp licenses for NetApp Ontap.", "x-allOf-name": "storage.NetAppLicense", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppLicense', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppLicense" ], "default": "storage.NetAppLicense", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppLicense" ], "default": "storage.NetAppLicense", "x-enum-as-string": true }, "ClusterUuid": { "description": "Unique identity of the device.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the license package.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "Summary state of license package based on all installed licenses.\n* `Unknown` - The summary state of the license package is unknown.\n* `Compliant` - The summary state of the license package is compliant.\n* `Noncompliant` - The summary state of the license package is noncompliant.\n* `Unlicensed` - The summary state of the license package is unlicensed.", "type": "string", "enum": [ "Unknown", "Compliant", "Noncompliant", "Unlicensed" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppLicense.List": { "title": "List of 'storage.NetAppLicense' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppLicense' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppLicense' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLicense" }, "nullable": true } } } ] }, "storage.NetAppLun.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppLun' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppLun' resources.", "x-one-of-name": "storage.NetAppLun.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppLun.Relationship": { "description": "A relationship to the 'storage.NetAppLun' resource, or the expanded 'storage.NetAppLun' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppLun.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppLun": { "title": "Storage:Net App Lun", "description": "The NetAppLun object refers to a logical unit number, an identifier for a device within the storage system, used to facilitate SAN protocol operations. It is crucial for managing block-level storage resources and ensuring efficient data access.\n#### Purpose\nA NetAppLun acts as a gateway for data transactions, allowing hosts to interact with storage devices seamlessly. This provides a structured environment for organizing and accessing data, supporting high-performance storage applications and workloads.\n#### Key Concepts\n- **Identifier Assignment:** Assigns unique identifiers to storage units, enabling precise management and access controls.\n- **Protocol Support:** Interfaces with SAN protocols to deliver block-level storage services, ensuring compatibility and performance.\n- **Mapping Capabilities:** Allows LUNs to be mapped to initiator groups, granting access and defining interaction scopes with storage resources.\n- **Operational State:** Monitors the administrative state of LUNs, ensuring they are available and functioning optimally within the storage infrastructure.", "x-allOf-name": "storage.NetAppLun", "allOf": [ { "$ref": "#/components/schemas/storage.BaseVolume" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppLun" ], "default": "storage.NetAppLun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppLun" ], "default": "storage.NetAppLun", "x-enum-as-string": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "ContainerState": { "description": "The state of the volume and aggregate that contain the LUN. LUNs are only available when their containers are available.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsMapped": { "description": "Reports if the LUN is mapped to one or more initiator groups.", "type": "string", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of LUN across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mapped": { "description": "Reports if the LUN is mapped to one or more initiator groups.", "deprecated": true, "x-sunset": "2027-03-01", "type": "boolean", "readOnly": true, "x-omitempty": true }, "OsType": { "description": "The operating system (OS) type for this LUN.\n* `Linux` - Family of open source Unix-like operating systems based on the Linux kernel.\n* `AIX` - Advanced Interactive Executive (AIX).\n* `HP-UX` - HP-UX is implementation of the Unix operating system, based on Unix System V.\n* `Hyper-V` - Windows Server 2008 or Windows Server 2012 Hyper-V.\n* `OpenVMS` - OpenVMS is multi-user, multiprocessing virtual memory-based operating system.\n* `Solaris` - Solaris is a Unix operating system.\n* `NetWare` - NetWare is a computer network operating system.\n* `VMware` - An enterprise-class, type-1 hypervisor developed by VMware for deploying and serving virtual computers.\n* `Windows` - Single-partition Windows disk using the Master Boot Record (MBR) partitioning style.\n* `Xen` - Xen is a type-1 hypervisor, providing services that allow multiple computer operating systems to execute on the same computer hardware concurrently.", "type": "string", "enum": [ "Linux", "AIX", "HP-UX", "Hyper-V", "OpenVMS", "Solaris", "NetWare", "VMware", "Windows", "Xen" ], "default": "Linux", "readOnly": true, "x-omitempty": true }, "Path": { "description": "Path where the LUN is mounted.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "Serial number for the provisioned LUN.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The administrative state of a LUN.\n* `offline` - The LUN is administratively offline, or a more detailed offline reason is not available.\n* `online` - The state of the LUN is online.", "type": "string", "enum": [ "offline", "online" ], "default": "offline", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the lun.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the LUN.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "The parent volume name for the lun.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppLunEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent.Relationship" }, "nullable": true, "readOnly": true }, "Host": { "description": "An array of relationships to storageNetAppInitiatorGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup.Relationship" }, "nullable": true, "readOnly": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppLun.List": { "title": "List of 'storage.NetAppLun' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppLun' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppLun' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun" }, "nullable": true } } } ] }, "storage.NetAppLunEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppLunEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppLunEvent' resources.", "x-one-of-name": "storage.NetAppLunEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppLunEvent.Relationship": { "description": "A relationship to the 'storage.NetAppLunEvent' resource, or the expanded 'storage.NetAppLunEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppLunEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppLunEvent": { "title": "Storage:Net App Lun Event", "description": "An event where the impacted resource type is a lun.", "x-allOf-name": "storage.NetAppLunEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppLunEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppLunEvent" ], "default": "storage.NetAppLunEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppLunEvent" ], "default": "storage.NetAppLunEvent", "x-enum-as-string": true }, "Lun": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun.Relationship", "description": "A reference to a storageNetAppLun resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppLunEvent.List": { "title": "List of 'storage.NetAppLunEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppLunEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppLunEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunEvent" }, "nullable": true } } } ] }, "storage.NetAppLunMap.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppLunMap' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppLunMap' resources.", "x-one-of-name": "storage.NetAppLunMap.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunMap.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppLunMap": { "title": "Storage:Net App Lun Map", "description": "NetApp LUN mapping is the process of associating a LUN with an initiator group. When a LUN is mapped to an initiator group, initiators in the initiator group are granted access to the LUN.", "x-allOf-name": "storage.NetAppLunMap", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHostLun" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppLunMap', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppLunMap" ], "default": "storage.NetAppLunMap", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppLunMap" ], "default": "storage.NetAppLunMap", "x-enum-as-string": true }, "IgroupUuid": { "description": "UUID of the initiator group.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "LunUuid": { "description": "Universally unique identifier of the LUN.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Host": { "description": "An array of relationships to storageNetAppInitiatorGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppInitiatorGroup.Relationship" }, "nullable": true, "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volume": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLun.Relationship", "description": "A reference to a storageNetAppLun resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppLunMap.List": { "title": "List of 'storage.NetAppLunMap' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppLunMap' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppLunMap' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppLunMap" }, "nullable": true } } } ] }, "storage.NetAppNamespace.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNamespace' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNamespace' resources.", "x-one-of-name": "storage.NetAppNamespace.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNamespace.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNamespace": { "title": "Storage:Net App Namespace", "description": "NetApp Namespace is a collection of addressable logical blocks presented to hosts connected to the storage virtual machine using the NVMe over Fabrics protocol.", "x-allOf-name": "storage.NetAppNamespace", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNamespace', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNamespace" ], "default": "storage.NetAppNamespace", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNamespace" ], "default": "storage.NetAppNamespace", "x-enum-as-string": true }, "ContainerState": { "description": "The state of the volume and aggregate that contain the NVMe namespace. Namespaces are only available when their containers are available.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsMapped": { "description": "Reports if the NVMe namespace is mapped to an NVMe subsystem.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The base name component of the NVMe namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "NamespaceId": { "description": "The NVMe namespace identifier. An identifier used by an NVMe controller to provide access to the NVMe namespace. The format for an NVMe namespace identifier is 8 hexadecimal digits (zero-filled) followed by a lower case \"h\".", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "The fully qualified path name of the NVMe namespace composed of a \"/vol\" prefix, the volume name, the (optional) qtree name and base name of the namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of the NVMe namespace. Normal states for a namespace are online and offline. Other states indicate errors (nvfail, space_error).", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization information of the namespace.", "$ref": "#/components/schemas/storage.BaseCapacity", "readOnly": true, "x-omitempty": true }, "SubsystemName": { "description": "The NVMe subsystem name to which the NVMe namespace is mapped.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the NVMe namespace.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the NVMe namespace.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "The volume name in which the NVMe namespace is located.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNamespace.List": { "title": "List of 'storage.NetAppNamespace' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNamespace' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNamespace' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNamespace" }, "nullable": true } } } ] }, "storage.NetAppNfsClient.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNfsClient' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNfsClient' resources.", "x-one-of-name": "storage.NetAppNfsClient.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsClient.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNfsClient": { "title": "Storage:Net App Nfs Client", "description": "A currently connected NFS client.", "x-allOf-name": "storage.NetAppNfsClient", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNfsClient', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNfsClient" ], "default": "storage.NetAppNfsClient", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNfsClient" ], "default": "storage.NetAppNfsClient", "x-enum-as-string": true }, "ClientIp": { "description": "Specifies IP address of the client.", "type": "string", "readOnly": true, "x-omitempty": true }, "IdleDuration": { "description": "Specifies an ISO-8601 format of date and time to retrieve the idle time duration in hours, minutes, and seconds format.", "type": "string", "readOnly": true, "x-omitempty": true }, "Protocol": { "description": "The NFS protocol version over which client is accessing the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerIp": { "description": "Specifies IP address of the server.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the NFS client.", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmUuid": { "description": "Unique identifier for the NetApp Storage Virtual Machine.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "The parent volume name for the NFS client.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeUuid": { "description": "Unique identifier for the NetApp Volume.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNfsClient.List": { "title": "List of 'storage.NetAppNfsClient' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNfsClient' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNfsClient' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsClient" }, "nullable": true } } } ] }, "storage.NetAppNfsService.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNfsService' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNfsService' resources.", "x-one-of-name": "storage.NetAppNfsService.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsService.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNfsService": { "title": "Storage:Net App Nfs Service", "description": "An NFS service retrieves the NFS configuration of a storage virtual machine.", "x-allOf-name": "storage.NetAppNfsService", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNfsService', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNfsService" ], "default": "storage.NetAppNfsService", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNfsService" ], "default": "storage.NetAppNfsService", "x-enum-as-string": true }, "NfsV3Enabled": { "description": "Specifies whether NFSv3 protocol is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "NfsV41Enabled": { "description": "Specifies whether NFSv4.1 protocol is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "NfsV4Enabled": { "description": "Specifies whether NFSv4.0 protocol is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SvmUuid": { "description": "Unique identifier for the NetApp Storage Virtual Machine.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNfsService.List": { "title": "List of 'storage.NetAppNfsService' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNfsService' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNfsService' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNfsService" }, "nullable": true } } } ] }, "storage.NetAppNode.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNode' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNode' resources.", "x-one-of-name": "storage.NetAppNode.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNode.Relationship": { "description": "A relationship to the 'storage.NetAppNode' resource, or the expanded 'storage.NetAppNode' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppNode.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppNode": { "title": "Storage:Net App Node", "description": "The NetAppNode object represents an individual controller within a NetAppCluster, responsible for managing specific services and components of the storage environment. This NetAppNode object is essential for understanding the operational state and capabilities of a node, contributing to the overall functionality of the cluster.\n#### Purpose\nA NetAppNode operates as a fundamental unit within a cluster, executing storage-related tasks, and maintaining critical infrastructure. It plays a crucial role in ensuring the stability and efficiency of storage operations, interfacing with other nodes to deliver comprehensive cluster services.\n#### Key Concepts\n- **Service Management:** Handles various services required for data storage and retrieval, including protocol management and connectivity.\n- **Component Integration:** Interfaces with hardware components, such as disks and ports, to facilitate seamless data flow and system interaction.\n- **Health Monitoring:** Continuously assesses the node's operational state, providing insights into performance metrics and potential issues.\n- **Resource Allocation:** Manages the distribution of tasks and data across nodes, optimizing resource utilization and ensuring balanced workloads.", "x-allOf-name": "storage.NetAppNode", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayController" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNode', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNode" ], "default": "storage.NetAppNode", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNode" ], "default": "storage.NetAppNode", "x-enum-as-string": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "CdpdEnabled": { "description": "Storage node option for cdpd state.\n* `unknown` - The cdpd option is unknown on the node.\n* `on` - The cdpd option is enabled on the node.\n* `off` - The cdpd option is disabled on the node.", "type": "string", "enum": [ "unknown", "on", "off" ], "default": "unknown", "readOnly": true, "x-omitempty": true }, "Health": { "description": "The health of the NetApp Node.", "deprecated": true, "x-sunset": "2027-03-01", "type": "boolean", "readOnly": true, "x-omitempty": true }, "HighAvailability": { "description": "Storage failover and giveback information.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppHighAvailability", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of NetApp Node across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The state of the NetApp Node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Systemid": { "description": "The system id of the NetApp Node.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of NetApp Node.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppNodeEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppNode.List": { "title": "List of 'storage.NetAppNode' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNode' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNode' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode" }, "nullable": true } } } ] }, "storage.NetAppNodeCdpNeighbor.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNodeCdpNeighbor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNodeCdpNeighbor' resources.", "x-one-of-name": "storage.NetAppNodeCdpNeighbor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeCdpNeighbor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNodeCdpNeighbor": { "title": "Storage:Net App Node Cdp Neighbor", "description": "Information about the CDP neighbor connected to a given NetApp node port.", "x-allOf-name": "storage.NetAppNodeCdpNeighbor", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNodeCdpNeighbor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNodeCdpNeighbor" ], "default": "storage.NetAppNodeCdpNeighbor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNodeCdpNeighbor" ], "default": "storage.NetAppNodeCdpNeighbor", "x-enum-as-string": true }, "Capabilities": { "type": "array", "items": { "description": "The functional capabilities of the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DeviceIp": { "description": "The IP address of the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiscoveredDevice": { "description": "The name of the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "HoldTimeRemaining": { "description": "The period of time for which CDP advertisements are cached.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Interface": { "description": "The interface of the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeName": { "description": "The node that owns the port for this CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Platform": { "description": "The platform of the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Port": { "description": "The port for this CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "Protocol": { "description": "The protocol used for CDP.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "The version of the operating system running on the CDP neighbor.", "type": "string", "readOnly": true, "x-omitempty": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNodeCdpNeighbor.List": { "title": "List of 'storage.NetAppNodeCdpNeighbor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNodeCdpNeighbor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNodeCdpNeighbor' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeCdpNeighbor" }, "nullable": true } } } ] }, "storage.NetAppNodeEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNodeEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNodeEvent' resources.", "x-one-of-name": "storage.NetAppNodeEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNodeEvent.Relationship": { "description": "A relationship to the 'storage.NetAppNodeEvent' resource, or the expanded 'storage.NetAppNodeEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppNodeEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppNodeEvent": { "title": "Storage:Net App Node Event", "description": "An event where the impacted resource type is a node.", "x-allOf-name": "storage.NetAppNodeEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNodeEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNodeEvent" ], "default": "storage.NetAppNodeEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNodeEvent" ], "default": "storage.NetAppNodeEvent", "x-enum-as-string": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNodeEvent.List": { "title": "List of 'storage.NetAppNodeEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNodeEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNodeEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNodeEvent" }, "nullable": true } } } ] }, "storage.NetAppNonDataIpInterface.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNonDataIpInterface' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNonDataIpInterface' resources.", "x-one-of-name": "storage.NetAppNonDataIpInterface.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNonDataIpInterface.Relationship": { "description": "A relationship to the 'storage.NetAppNonDataIpInterface' resource, or the expanded 'storage.NetAppNonDataIpInterface' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppNonDataIpInterface.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppNonDataIpInterface": { "title": "Storage:Net App Non Data Ip Interface", "description": "NetApp Non-Data IP interface is a logical interface for management within the cluster scope.", "x-allOf-name": "storage.NetAppNonDataIpInterface", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseIpInterface" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNonDataIpInterface', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNonDataIpInterface" ], "default": "storage.NetAppNonDataIpInterface", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNonDataIpInterface" ], "default": "storage.NetAppNonDataIpInterface", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppNonDataIpInterfaceEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent.Relationship" }, "nullable": true, "readOnly": true }, "NetAppEthernetPort": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppEthernetPort.Relationship", "description": "A reference to a storageNetAppEthernetPort resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNonDataIpInterface.List": { "title": "List of 'storage.NetAppNonDataIpInterface' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNonDataIpInterface' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNonDataIpInterface' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface" }, "nullable": true } } } ] }, "storage.NetAppNonDataIpInterfaceEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNonDataIpInterfaceEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNonDataIpInterfaceEvent' resources.", "x-one-of-name": "storage.NetAppNonDataIpInterfaceEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNonDataIpInterfaceEvent.Relationship": { "description": "A relationship to the 'storage.NetAppNonDataIpInterfaceEvent' resource, or the expanded 'storage.NetAppNonDataIpInterfaceEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppNonDataIpInterfaceEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppNonDataIpInterfaceEvent": { "title": "Storage:Net App Non Data Ip Interface Event", "description": "An event where the impacted resource type is an ip interface.", "x-allOf-name": "storage.NetAppNonDataIpInterfaceEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNonDataIpInterfaceEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNonDataIpInterfaceEvent" ], "default": "storage.NetAppNonDataIpInterfaceEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNonDataIpInterfaceEvent" ], "default": "storage.NetAppNonDataIpInterfaceEvent", "x-enum-as-string": true }, "IpInterface": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterface.Relationship", "description": "A reference to a storageNetAppNonDataIpInterface resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNonDataIpInterfaceEvent.List": { "title": "List of 'storage.NetAppNonDataIpInterfaceEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNonDataIpInterfaceEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNonDataIpInterfaceEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNonDataIpInterfaceEvent" }, "nullable": true } } } ] }, "storage.NetAppNtpServer.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppNtpServer' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppNtpServer' resources.", "x-one-of-name": "storage.NetAppNtpServer.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNtpServer.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppNtpServer": { "title": "Storage:Net App Ntp Server", "description": "External NTP time servers ONTAP uses for time adjustment and correction.", "x-allOf-name": "storage.NetAppNtpServer", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppNtpServer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppNtpServer" ], "default": "storage.NetAppNtpServer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppNtpServer" ], "default": "storage.NetAppNtpServer", "x-enum-as-string": true }, "AuthenticationEnabled": { "description": "Indicates whether or not NTP symmetric authentication is enabled.", "deprecated": true, "x-sunset": "2027-03-01", "type": "boolean", "readOnly": true, "x-omitempty": true }, "AuthenticationKeyId": { "description": "NTP symmetric authentication key identifier or index number (ID).", "type": "string", "readOnly": true, "x-omitempty": true }, "ClusterUuid": { "description": "Unique identity of the device.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "IsAuthenticationEnabled": { "description": "Indicates whether or not NTP symmetric authentication is enabled.", "type": "string", "readOnly": true, "x-omitempty": true }, "Server": { "description": "NTP server host name, IPv4, or IPv6 address.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "NTP protocol version for server. Valid versions are 3, 4, or auto.\n* `none` - Default unknown NTP protocol version.\n* `3` - NTP protocol version is 3.\n* `4` - NTP protocol version is 4.\n* `auto` - NTP protocol version is auto.", "type": "string", "enum": [ "none", "3", "4", "auto" ], "default": "none", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppNtpServer.List": { "title": "List of 'storage.NetAppNtpServer' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppNtpServer' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppNtpServer' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNtpServer" }, "nullable": true } } } ] }, "storage.NetAppPerformanceMetricsAverage": { "title": "Storage:Net App Performance Metrics Average", "description": "Average performance metrics data for a NetApp storage resource over a given period of time.", "x-allOf-name": "storage.NetAppPerformanceMetricsAverage", "allOf": [ { "$ref": "#/components/schemas/storage.BasePerformanceMetricsAverage" } ] }, "storage.NetAppPort": { "title": "Storage:Net App Port", "description": "A logical representation of a network port.", "x-allOf-name": "storage.NetAppPort", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppPort" ], "default": "storage.NetAppPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppPort" ], "default": "storage.NetAppPort", "x-enum-as-string": true }, "Name": { "description": "Name associated with this port.", "type": "string", "readOnly": true, "x-omitempty": true }, "NodeName": { "description": "Name of the node associated with this port.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Unique identifier of the port.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppQtree.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppQtree' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppQtree' resources.", "x-one-of-name": "storage.NetAppQtree.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppQtree.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppQtree": { "title": "Storage:Net App Qtree", "description": "NetApp qtree is a logically defined file system that can exist as a special subdirectory of the root directory within a volume.", "x-allOf-name": "storage.NetAppQtree", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppQtree', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppQtree" ], "default": "storage.NetAppQtree", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppQtree" ], "default": "storage.NetAppQtree", "x-enum-as-string": true }, "ExportPolicyId": { "description": "Unique identifier of NetApp export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the NetApp Qtree.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "Client visible path to the qtree.", "type": "string", "readOnly": true, "x-omitempty": true }, "Permission": { "description": "Identifies the UNIX permissions for the qtree.", "type": "string", "readOnly": true, "x-omitempty": true }, "QtreeId": { "description": "NetApp Qtree ID, unique within the qtree's volume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SecurityStyle": { "description": "Identifies the security style for the qtree, it determines how access to the qtree is controlled.\n* `UNIX` - Security style for UNIX uid, gid and mode bits.\n* `NTFS` - Security style for CIFS ACLs.\n* `Mixed` - Security style for NFS and CIFS access.", "type": "string", "enum": [ "UNIX", "NTFS", "Mixed" ], "default": "UNIX", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the qtree.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeName": { "description": "The parent volume name for the qtree.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeUuid": { "description": "NetApp Volume uuid, unique identifier for the NetApp volume.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppQtree.List": { "title": "List of 'storage.NetAppQtree' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppQtree' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppQtree' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppQtree" }, "nullable": true } } } ] }, "storage.NetAppSchedule.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSchedule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSchedule' resources.", "x-one-of-name": "storage.NetAppSchedule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSchedule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSchedule": { "title": "Storage:Net App Schedule", "description": "NetApp schedule is a configurable entity on which various tasks (for instance, volume Snapshot copies and mirror replications) are run.", "x-allOf-name": "storage.NetAppSchedule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSchedule" ], "default": "storage.NetAppSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSchedule" ], "default": "storage.NetAppSchedule", "x-enum-as-string": true }, "Name": { "description": "The name of the schedule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The type of the schedule (cron or interval).", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of the schedule.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSchedule.List": { "title": "List of 'storage.NetAppSchedule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSchedule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSchedule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSchedule" }, "nullable": true } } } ] }, "storage.NetAppSensor.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSensor' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSensor' resources.", "x-one-of-name": "storage.NetAppSensor.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSensor.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSensor": { "title": "Storage:Net App Sensor", "description": "Information for a particular sensor on a NetApp storage array controller.", "x-allOf-name": "storage.NetAppSensor", "allOf": [ { "$ref": "#/components/schemas/equipment.BaseSensor" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSensor', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSensor" ], "default": "storage.NetAppSensor", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSensor" ], "default": "storage.NetAppSensor", "x-enum-as-string": true }, "ArrayController": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppNode.Relationship", "description": "A reference to a storageNetAppNode resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSensor.List": { "title": "List of 'storage.NetAppSensor' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSensor' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSensor' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSensor" }, "nullable": true } } } ] }, "storage.NetAppSnapMirrorRelationship.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSnapMirrorRelationship' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSnapMirrorRelationship' resources.", "x-one-of-name": "storage.NetAppSnapMirrorRelationship.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSnapMirrorRelationship.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSnapMirrorRelationship": { "title": "Storage:Net App Snap Mirror Relationship", "description": "NetApp SnapMirror relationship.", "x-allOf-name": "storage.NetAppSnapMirrorRelationship", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSnapMirrorRelationship', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSnapMirrorRelationship" ], "default": "storage.NetAppSnapMirrorRelationship", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSnapMirrorRelationship" ], "default": "storage.NetAppSnapMirrorRelationship", "x-enum-as-string": true }, "DestinationPath": { "description": "Path to the destination endpoint of a SnapMirror relationship. Examples: ONTAP FlexVol/FlexGroup - svm1:volume1; ONTAP SVM - svm1: ; ONTAP Consistency Group - svm1:/cg/cg_name.", "type": "string", "readOnly": true, "x-omitempty": true }, "Healthy": { "description": "Whether the relationship is healthy or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "LagTime": { "description": "Time since the exported Snapshot copy was created.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "Name of the NetApp SnapMirror policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyType": { "description": "SnapMirror policy type can be async, sync, or continuous.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyUuid": { "description": "Uuid of the NetApp SnapMirror policy.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "SourcePath": { "description": "Path to the source endpoint of a SnapMirror relationship. Examples: ONTAP FlexVol/FlexGroup - svm1:volume1; ONTAP SVM - svm1: ; ONTAP Consistency Group - svm1:/cg/cg_name.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "State of the relationship.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Uuid of the NetApp SnapMirror relationship.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DestinationTenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapMirrorPolicy.Relationship", "description": "A reference to a storageNetAppBaseSnapMirrorPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSnapMirrorRelationship.List": { "title": "List of 'storage.NetAppSnapMirrorRelationship' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSnapMirrorRelationship' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSnapMirrorRelationship' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSnapMirrorRelationship" }, "nullable": true } } } ] }, "storage.NetAppSnapshotPolicySchedule": { "title": "Storage:Net App Snapshot Policy Schedule", "description": "NetApp Snapshot policy schedule information.", "x-allOf-name": "storage.NetAppSnapshotPolicySchedule", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSnapshotPolicySchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSnapshotPolicySchedule" ], "default": "storage.NetAppSnapshotPolicySchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSnapshotPolicySchedule" ], "default": "storage.NetAppSnapshotPolicySchedule", "x-enum-as-string": true }, "Count": { "description": "The number of Snapshot copies to maintain for this schedule.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Label": { "description": "Label for SnapMirror operations.", "type": "string", "readOnly": true, "x-omitempty": true }, "ScheduleName": { "description": "Schedule at which Snapshot copies are captured on the volume.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppStorageClusterEfficiency": { "title": "Storage:Net App Storage Cluster Efficiency", "description": "Cluster space efficiency information.", "x-allOf-name": "storage.NetAppStorageClusterEfficiency", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppStorageClusterEfficiency', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppStorageClusterEfficiency" ], "default": "storage.NetAppStorageClusterEfficiency", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppStorageClusterEfficiency" ], "default": "storage.NetAppStorageClusterEfficiency", "x-enum-as-string": true }, "LogicalUsed": { "description": "The logical space used for the cluster.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Ratio": { "description": "Data reduction ratio (logical_used / used).", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Savings": { "description": "Space saved by storage efficiencies (logical_used - used).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppStorageUtilization": { "title": "Storage:Net App Storage Utilization", "description": "Storage capacity information which includes savings realized.", "x-allOf-name": "storage.NetAppStorageUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppStorageUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppStorageUtilization" ], "default": "storage.NetAppStorageUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppStorageUtilization" ], "default": "storage.NetAppStorageUtilization", "x-enum-as-string": true }, "LogicalUsed": { "description": "Total logical used capacity, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Savings": { "description": "Total savings capacity, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NetAppStorageVm.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppStorageVm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppStorageVm' resources.", "x-one-of-name": "storage.NetAppStorageVm.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppStorageVm.Relationship": { "description": "A relationship to the 'storage.NetAppStorageVm' resource, or the expanded 'storage.NetAppStorageVm' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppStorageVm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppStorageVm": { "title": "Storage:Net App Storage Vm", "description": "The NetAppStorageVm object encapsulates a storage virtual machine, a fundamental entity within the NetAppCluster environment, responsible for serving data to clients through logical interfaces. It is integral to managing virtualized storage resources and ensuring efficient data delivery.\n#### Purpose\nA NetAppStorageVm provides a virtual framework for storage operations, enabling flexible data management and service provisioning. It acts as a virtual entity within the cluster, orchestrating data access and supporting diverse protocol configurations.\n#### Key Concepts\n- **Virtualization:** Offers a virtualized approach to storage management, facilitating dynamic resource allocation and provisioning.\n- **Service Integration:** Manages multiple logical interfaces (LIFs) to deliver data services to clients, ensuring seamless connectivity and interaction.\n- **Protocol Support:** Supports various storage protocols, including NFS, CIFS, iSCSI, and NVMe, to accommodate diverse client requirements.\n- **Data Protection:** Implements robust data protection strategies, utilizing SnapMirror and other technologies to safeguard data integrity and availability.", "x-allOf-name": "storage.NetAppStorageVm", "allOf": [ { "$ref": "#/components/schemas/storage.BaseTenant" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppStorageVm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppStorageVm" ], "default": "storage.NetAppStorageVm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppStorageVm" ], "default": "storage.NetAppStorageVm", "x-enum-as-string": true }, "Aggregates": { "type": "array", "items": { "description": "List of allowed aggregates for SVM volumes.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "CifsEnabled": { "description": "Status for Common Internet File System protocol ( CIFS ) allowed to run on Vservers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DnsDomains": { "type": "array", "items": { "description": "A list of Domain Name System ( DNS ) domains.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FcpEnabled": { "description": "Status for Fibre Channel Protocol ( FCP ) allowed to run on Vservers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Ipspace": { "description": "IPspace name. IPspaces are distinct IP address spaces in which storage virtual machines (SVMs) reside.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsProtected": { "description": "Specifies whether the Storage VM is a SnapMirror source Storage VM, using SnapMirror to protect its data.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiEnabled": { "description": "Status for iSCSI protocol allowed to run on Vservers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of VServer across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "NameServers": { "type": "array", "items": { "description": "The list of IP addresses of the DNS servers. Addresses can be either IPv4 or IPv6 addresses.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "NativeFpolicyCount": { "description": "The number of native FPolicy engines enabled on this SVM.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "NfsEnabled": { "description": "Status for Network File System Protocol ( NFS ) allowed to run on Vservers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "NvmeEnabled": { "description": "Status for NVME protocol allowed to run on Vservers.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Subtype": { "description": "SVM subtype (default, dp_destination, sync_source, or sync_destination). The SVM subtype sync_destination is created automatically when an SVM of subtype sync_source is created on the source MetroCluster cluster.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DiskPool": { "description": "An array of relationships to storageNetAppAggregate resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.Relationship" }, "nullable": true, "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppSvmEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.NetAppStorageVm.List": { "title": "List of 'storage.NetAppStorageVm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppStorageVm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppStorageVm' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm" }, "nullable": true } } } ] }, "storage.NetAppSvmEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSvmEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSvmEvent' resources.", "x-one-of-name": "storage.NetAppSvmEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSvmEvent.Relationship": { "description": "A relationship to the 'storage.NetAppSvmEvent' resource, or the expanded 'storage.NetAppSvmEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppSvmEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppSvmEvent": { "title": "Storage:Net App Svm Event", "description": "An event where the impacted resource type is a storage vm.", "x-allOf-name": "storage.NetAppSvmEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSvmEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSvmEvent" ], "default": "storage.NetAppSvmEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSvmEvent" ], "default": "storage.NetAppSvmEvent", "x-enum-as-string": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSvmEvent.List": { "title": "List of 'storage.NetAppSvmEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSvmEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSvmEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmEvent" }, "nullable": true } } } ] }, "storage.NetAppSvmSnapMirrorPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSvmSnapMirrorPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSvmSnapMirrorPolicy' resources.", "x-one-of-name": "storage.NetAppSvmSnapMirrorPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapMirrorPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSvmSnapMirrorPolicy": { "title": "Storage:Net App Svm Snap Mirror Policy", "description": "NetApp SnapMirror policy owned by a storage virtual machine. NetApp SnapMirror policy when applied to a SnapMirror relationship, controls the behavior of the relationship and specifies the configuration attributes for that relationship.", "x-allOf-name": "storage.NetAppSvmSnapMirrorPolicy", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapMirrorPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSvmSnapMirrorPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSvmSnapMirrorPolicy" ], "default": "storage.NetAppSvmSnapMirrorPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSvmSnapMirrorPolicy" ], "default": "storage.NetAppSvmSnapMirrorPolicy", "x-enum-as-string": true }, "SvmName": { "description": "The storage virtual machine name for the policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSvmSnapMirrorPolicy.List": { "title": "List of 'storage.NetAppSvmSnapMirrorPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSvmSnapMirrorPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSvmSnapMirrorPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapMirrorPolicy" }, "nullable": true } } } ] }, "storage.NetAppSvmSnapshotPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppSvmSnapshotPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppSvmSnapshotPolicy' resources.", "x-one-of-name": "storage.NetAppSvmSnapshotPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapshotPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppSvmSnapshotPolicy": { "title": "Storage:Net App Svm Snapshot Policy", "description": "NetApp Snapshot policy that is scoped to a storage virtual machine. The policy controls the behavior and schedule of snapshots when applied to a volume.", "x-allOf-name": "storage.NetAppSvmSnapshotPolicy", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseSnapshotPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppSvmSnapshotPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppSvmSnapshotPolicy" ], "default": "storage.NetAppSvmSnapshotPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppSvmSnapshotPolicy" ], "default": "storage.NetAppSvmSnapshotPolicy", "x-enum-as-string": true }, "SvmName": { "description": "The storage virtual machine name for the policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppSvmSnapshotPolicy.List": { "title": "List of 'storage.NetAppSvmSnapshotPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppSvmSnapshotPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppSvmSnapshotPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppSvmSnapshotPolicy" }, "nullable": true } } } ] }, "storage.NetAppVolume.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppVolume' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppVolume' resources.", "x-one-of-name": "storage.NetAppVolume.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppVolume.Relationship": { "description": "A relationship to the 'storage.NetAppVolume' resource, or the expanded 'storage.NetAppVolume' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppVolume.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppVolume": { "title": "Storage:Net App Volume", "description": "The NetAppVolume object is a versatile data container that enables partitioning and management of storage resources within a NetAppCluster. It is instrumental in organizing data efficiently and securely, supporting a wide range of storage use cases.\n#### Purpose\nA NetAppVolume serves as a logical unit for data storage, providing isolation and control over data access and management. It allows administrators to define storage characteristics, implement data protection strategies, and optimize resource usage within the cluster.\n#### Key Concepts\n- **Data Isolation:** Ensures that data stored within a volume is segregated from other volumes, enabling tailored access controls and management policies.\n- **Flexibility:** Supports various volume types and configurations, catering to diverse application requirements and storage needs.\n- **Protection Mechanisms:** Implements advanced data protection features, such as snapshots and replication, to safeguard data integrity and availability.\n- **Performance Management:** Utilizes sophisticated algorithms to optimize data access speeds and responsiveness, enhancing overall system efficiency.", "x-allOf-name": "storage.NetAppVolume", "allOf": [ { "$ref": "#/components/schemas/storage.BaseStorageContainer" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppVolume', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppVolume" ], "default": "storage.NetAppVolume", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppVolume" ], "default": "storage.NetAppVolume", "x-enum-as-string": true }, "AutosizeMode": { "description": "The autosize mode for NetApp Volume. Modes can be off or grow or grow_shrink.\n* `off` - The volume will not grow or shrink in size in response to the amount of used space.\n* `grow` - The volume will automatically grow when used space in the volume is above the grow threshold.\n* `grow_shrink` - The volume will grow or shrink in size in response to the amount of used space.", "type": "string", "enum": [ "off", "grow", "grow_shrink" ], "default": "off", "readOnly": true, "x-omitempty": true }, "AvgPerformanceMetrics": { "description": "Average performance metrics for over a period of time.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppPerformanceMetricsAverage", "readOnly": true, "x-omitempty": true }, "ExportPolicyName": { "description": "The name of the Export Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "FlexCacheEndpointType": { "description": "FlexCache endpoint type. The endpoint type can be the origin of a FlexCache volume, a FlexCache volume, or neither.", "type": "string", "readOnly": true, "x-omitempty": true }, "IsObjectStore": { "description": "Specifies whether the volume is provisioned for an object store server.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Key": { "description": "Unique identifier of a NetApp Volume across data center.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotAutodeleteEnabled": { "description": "Specifies whether Snaphot copy autodelete is currently enabled on this volume.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "SnapshotPolicyName": { "description": "The name of the Snapshot Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotPolicyUuid": { "description": "The UUID of the Snapshot Policy.", "type": "string", "pattern": "^$|^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "SnapshotReservePercent": { "description": "The space that has been set aside as a reserve for Snapshot copy usage represented as a percent.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SnapshotUsed": { "description": "The total space used by Snapshot copies in the volume represented in bytes.", "type": "number", "format": "double", "readOnly": true, "x-omitempty": true }, "State": { "description": "The current state of a NetApp volume.\n* `offline` - Read and write access to the volume is not allowed.\n* `online` - Read and write access to the volume is allowed.\n* `error` - Storage volume state of error type.\n* `mixed` - The constituents of a FlexGroup volume are not all in the same state.", "type": "string", "enum": [ "offline", "online", "error", "mixed" ], "default": "offline", "readOnly": true, "x-omitempty": true }, "Style": { "description": "The style of the volume (FlexGroup or FlexVol).", "type": "string", "readOnly": true, "x-omitempty": true }, "SvmName": { "description": "The storage virtual machine name for the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "NetApp volume type. The volume type can be Read-write, Data-protection, or Load-sharing.\n* `data-protection` - Prevents modification of the data on the Volume.\n* `read-write` - Data on the Volume can be modified.\n* `load-sharing` - The volume type is Load Sharing DP.", "type": "string", "enum": [ "data-protection", "read-write", "load-sharing" ], "default": "data-protection", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "Universally unique identifier of a NetApp Volume.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "DiskPool": { "description": "An array of relationships to storageNetAppAggregate resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppAggregate.Relationship" }, "nullable": true, "readOnly": true }, "Events": { "description": "An array of relationships to storageNetAppVolumeEvent resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent.Relationship" }, "nullable": true, "readOnly": true }, "Tenant": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppStorageVm.Relationship", "description": "A reference to a storageNetAppStorageVm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppVolume.List": { "title": "List of 'storage.NetAppVolume' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppVolume' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppVolume' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume" }, "nullable": true } } } ] }, "storage.NetAppVolumeEvent.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppVolumeEvent' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppVolumeEvent' resources.", "x-one-of-name": "storage.NetAppVolumeEvent.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppVolumeEvent.Relationship": { "description": "A relationship to the 'storage.NetAppVolumeEvent' resource, or the expanded 'storage.NetAppVolumeEvent' resource, or the 'null' value.", "x-one-of-name": "storage.NetAppVolumeEvent.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.NetAppVolumeEvent": { "title": "Storage:Net App Volume Event", "description": "An event where the impacted resource type is a volume.", "x-allOf-name": "storage.NetAppVolumeEvent", "allOf": [ { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppBaseEvent" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppVolumeEvent', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppVolumeEvent" ], "default": "storage.NetAppVolumeEvent", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppVolumeEvent" ], "default": "storage.NetAppVolumeEvent", "x-enum-as-string": true }, "Volume": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppVolumeEvent.List": { "title": "List of 'storage.NetAppVolumeEvent' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppVolumeEvent' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppVolumeEvent' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeEvent" }, "nullable": true } } } ] }, "storage.NetAppVolumeSnapshot.Response": { "description": "The response body of a HTTP GET request for the 'storage.NetAppVolumeSnapshot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NetAppVolumeSnapshot' resources.", "x-one-of-name": "storage.NetAppVolumeSnapshot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeSnapshot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NetAppVolumeSnapshot": { "title": "Storage:Net App Volume Snapshot", "description": "NetApp Volume Snapshot is a read-only image of a traditional or FlexVol volume, or an aggregate, that captures the state of the file system at a point in time.", "x-allOf-name": "storage.NetAppVolumeSnapshot", "allOf": [ { "$ref": "#/components/schemas/storage.BaseSnapshot" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NetAppVolumeSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NetAppVolumeSnapshot" ], "default": "storage.NetAppVolumeSnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NetAppVolumeSnapshot" ], "default": "storage.NetAppVolumeSnapshot", "x-enum-as-string": true }, "Uuid": { "description": "Universally unique identifier of the volume snapshot.", "type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppCluster.Relationship", "description": "A reference to a storageNetAppCluster resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageContainer": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolume.Relationship", "description": "A reference to a storageNetAppVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.NetAppVolumeSnapshot.List": { "title": "List of 'storage.NetAppVolumeSnapshot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NetAppVolumeSnapshot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NetAppVolumeSnapshot' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.NetAppVolumeSnapshot" }, "nullable": true } } } ] }, "storage.NvmeDedicatedHotSpareConfiguration": { "title": "DedicatedHotSpare Configuration for HW-RAID of Nvme", "description": "Dedicated Hot Spare type models a single dedicated hot spare that needs to be created for NVMe RAID drive group on reboot. Used in activation workflow.", "x-allOf-name": "storage.NvmeDedicatedHotSpareConfiguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NvmeDedicatedHotSpareConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NvmeDedicatedHotSpareConfiguration" ], "default": "storage.NvmeDedicatedHotSpareConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NvmeDedicatedHotSpareConfiguration" ], "default": "storage.NvmeDedicatedHotSpareConfiguration", "x-enum-as-string": true }, "IsNewVd": { "description": "This defines if the vd does not exists at endpoint for specific storage controller per drive group. Only if it's false we will create dedicated hot spares for the existing vds.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the virtual drive. The name can be between 1 and 15 alphanumeric characters. Spaces or any special characters other than - (hyphen) and _ (underscore) are not allowed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Slot": { "description": "Physical Disk Slot that is used as dedicated hot spare.", "type": "string", "readOnly": true, "x-omitempty": true }, "VolumeDn": { "description": "The volume dn of the dedicated hot spare, this will be unique for each dedicated hot spare.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NvmePhysicalDiskState": { "title": "Physical Disk state for HW-RAID of Nvme", "description": "NvmePhysicalDiskState type models physical disk state that needs to be created for NVMe Raid on reboot. Used in activation workflow.", "x-allOf-name": "storage.NvmePhysicalDiskState", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NvmePhysicalDiskState', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NvmePhysicalDiskState" ], "default": "storage.NvmePhysicalDiskState", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NvmePhysicalDiskState" ], "default": "storage.NvmePhysicalDiskState", "x-enum-as-string": true }, "Slot": { "description": "Physical Disk Slot that is to be configured.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "Physical Disk State that is to be set at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NvmeRaidConfiguration.Response": { "description": "The response body of a HTTP GET request for the 'storage.NvmeRaidConfiguration' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.NvmeRaidConfiguration' resources.", "x-one-of-name": "storage.NvmeRaidConfiguration.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.NvmeRaidConfiguration.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.NvmeRaidConfiguration": { "title": "Nvme RaidConfiguration", "description": "Object that stores Nvme Raid Configuration data under a Server Profile, used for creation of vd, update pd state for NVMe on reboot.", "x-allOf-name": "storage.NvmeRaidConfiguration", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NvmeRaidConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NvmeRaidConfiguration" ], "default": "storage.NvmeRaidConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NvmeRaidConfiguration" ], "default": "storage.NvmeRaidConfiguration", "x-enum-as-string": true }, "ControllerDn": { "description": "The storage controller Dn Name for which Nvme RAID is created at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerMoid": { "description": "The storage controller Moid for which Nvme RAID creation is supported.", "type": "string", "readOnly": true, "x-omitempty": true }, "ControllerSeries": { "description": "Describes series of the installed controller. This will be used in the activation step after reboot to calculate the different parameters w.r.t specific controller series.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskStates": { "type": "array", "items": { "description": "Configuration of the NVMe HW RAID dedicated hot spares to apply at endpoint.", "$ref": "#/components/schemas/storage.NvmePhysicalDiskState", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DriveGroups": { "type": "array", "items": { "description": "Configuration of the NVMe HW RAID drive group to apply at endpoint.", "$ref": "#/components/schemas/storage.NvmeRaidDriveGroup", "readOnly": true, "x-omitempty": true }, "nullable": true }, "ServerProfile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "StoragePolicy": { "$ref": "#/components/schemas/storage.StoragePolicy.Relationship", "description": "A reference to a storageStoragePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.NvmeRaidConfiguration.List": { "title": "List of 'storage.NvmeRaidConfiguration' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.NvmeRaidConfiguration' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.NvmeRaidConfiguration' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.NvmeRaidConfiguration" }, "nullable": true } } } ] }, "storage.NvmeRaidDriveGroup": { "title": "Virtual Drives Raid Configuration for HW-RAID of Nvme", "description": "NvmeRAIDVirtualDrives type models a single drive group that needs to be created for NVMe RAID on reboot. Used in activation workflow.", "x-allOf-name": "storage.NvmeRaidDriveGroup", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NvmeRaidDriveGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NvmeRaidDriveGroup" ], "default": "storage.NvmeRaidDriveGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NvmeRaidDriveGroup" ], "default": "storage.NvmeRaidDriveGroup", "x-enum-as-string": true }, "Configurations": { "type": "array", "items": { "description": "Configuration of the NVMe HW RAID virtual drive to apply at endpoint.", "$ref": "#/components/schemas/storage.NvmeVirtualDriveConfiguration", "readOnly": true, "x-omitempty": true }, "nullable": true }, "DedicatedHotSparesForDriveGroup": { "type": "array", "items": { "description": "Configuration of the NVMe HW RAID dedicated hot spares to apply at endpoint.", "$ref": "#/components/schemas/storage.NvmeDedicatedHotSpareConfiguration", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Name": { "description": "The DriveGroup Name which is used to create virtual Drives at endpoint.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.NvmeVirtualDriveConfiguration": { "title": "Virtual Drive Configuration for HW-RAID of Nvme", "description": "Virtual Drive type models a single virtual drive that needs to be created for NVMe Raid on reboot. Used in activation workflow.", "x-allOf-name": "storage.NvmeVirtualDriveConfiguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.NvmeVirtualDriveConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.NvmeVirtualDriveConfiguration" ], "default": "storage.NvmeVirtualDriveConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.NvmeVirtualDriveConfiguration" ], "default": "storage.NvmeVirtualDriveConfiguration", "x-enum-as-string": true }, "AccessPolicy": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Bootable": { "description": "This defines the characteristics of a specific virtual drive.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ControllerDn": { "description": "This defines the characteristics of a specific storage controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "DedicatedHotSpare": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskCachePolicy": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the virtual drive. The name can be between 1 and 15 alphanumeric characters. Spaces or any special characters other than - (hyphen) and _ (underscore) are not allowed.", "type": "string", "readOnly": true, "x-omitempty": true }, "RaidLevel": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReadPolicy": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "SelfEncrypt": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpanDisks": { "type": "array", "items": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "StripSize": { "description": "Virtual drive strip size.", "type": "string", "readOnly": true, "x-omitempty": true }, "WritePolicy": { "description": "This defines the characteristics of a specific virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.PhysicalDisk.Response": { "description": "The response body of a HTTP GET request for the 'storage.PhysicalDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PhysicalDisk' resources.", "x-one-of-name": "storage.PhysicalDisk.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.PhysicalDisk.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PhysicalDisk.Relationship": { "description": "A relationship to the 'storage.PhysicalDisk' resource, or the expanded 'storage.PhysicalDisk' resource, or the 'null' value.", "x-one-of-name": "storage.PhysicalDisk.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.PhysicalDisk" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PhysicalDisk": { "title": "Storage:Physical Disk", "description": "Physical Disk on a server.", "x-allOf-name": "storage.PhysicalDisk", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PhysicalDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PhysicalDisk" ], "default": "storage.PhysicalDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PhysicalDisk" ], "default": "storage.PhysicalDisk", "x-enum-as-string": true }, "BackgroundOperations": { "description": "List of background operations underway.", "type": "string", "x-omitempty": true }, "BlockSize": { "description": "The block size of the physical disk in bytes.", "type": "string", "readOnly": true, "x-omitempty": true }, "Bootable": { "description": "This field identifies the disk drive as bootable if set to true.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigurationCheckpoint": { "description": "The current configuration checkpoint of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigurationState": { "description": "The current configuration state of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Description": { "description": "This field displays the description of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DisabledForRemoval": { "description": "The physical disk is disabled for removal.", "type": "boolean", "x-omitempty": true }, "DiscoveredPath": { "description": "The discovered path of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskId": { "description": "This field identifies the ID assigned to physical disks.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskState": { "description": "This field identifies the health of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriveFirmware": { "description": "This field identifies the disk firmware running in the disk.", "type": "string", "x-omitempty": true }, "DriveState": { "description": "The drive state as reported by the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "EncryptionStatus": { "description": "Encryption status of the physical disk.", "type": "string", "x-omitempty": true }, "FailurePredicted": { "description": "Possibility of physical disk failure.", "type": "boolean", "x-omitempty": true }, "FdeCapable": { "description": "Full-Disk Encryption capability parameter of the physical disk.", "type": "string", "x-omitempty": true }, "Health": { "description": "This field displays the health of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "HealthMessage": { "description": "This field displays the message in relation to physical disk health.", "type": "string", "readOnly": true, "x-omitempty": true }, "HealthResolution": { "description": "This field displays the recommended action to take regarding the physical disk based on its health status.", "type": "string", "readOnly": true, "x-omitempty": true }, "HotSpareType": { "description": "Type of hotspare configured on the physical disk.", "type": "string", "x-omitempty": true }, "IndicatorLed": { "description": "Status of the locator LED corresponding to the physical disk.", "type": "string", "x-omitempty": true }, "IsPlatformSupported": { "description": "This field indicates whether the physical disk is supported on the server or not.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "LinkSpeed": { "description": "The speed of the link between the drive and the controller.", "type": "string", "readOnly": true, "x-omitempty": true }, "LinkState": { "description": "The current link state of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "MaximumOperatingTemperature": { "description": "Maximum operating temperature of drive in Celsius.", "type": "integer", "format": "int64", "x-omitempty": true }, "MediaErrorCount": { "description": "Media error count on the physical disk.", "type": "integer", "format": "int64", "x-omitempty": true }, "Name": { "description": "Detailed name of the physical disk.", "type": "string", "x-omitempty": true }, "NonCoercedSizeBytes": { "description": "Physical disk non-coerced size in bytes.", "type": "integer", "format": "int64", "x-omitempty": true }, "NumBlocks": { "description": "The number of blocks present on the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperPowerState": { "description": "Operational power of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperQualifierReason": { "description": "For certain states, indicates the reason why the operState is in that state.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Physical Disk.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Operability": { "description": "This field identifies the disk operability of the disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperatingTemperature": { "description": "Operating temperature of drive in Celsius.", "type": "integer", "format": "int64", "x-omitempty": true }, "PartNumber": { "description": "This field displays the part number of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "PercentLifeLeft": { "description": "Percentage of write cycles remaining in a solid state drive (SSD).", "type": "integer", "format": "int64", "x-omitempty": true }, "PercentReservedCapacityConsumed": { "description": "Percentage of reserve capacity consumed.", "type": "integer", "format": "int64", "x-omitempty": true }, "PerformancePercent": { "description": "Performance at which the device operating expressed in percentage.", "type": "integer", "format": "int64", "x-omitempty": true }, "PhysicalBlockSize": { "description": "The block size of the installed physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pid": { "description": "This field displays the product ID of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "PowerCycleCount": { "description": "Number of powercycles the drive has undergone.", "type": "integer", "format": "int64", "x-omitempty": true }, "PowerOnHours": { "description": "Number of hours the drive has been powered on.", "type": "integer", "format": "int64", "x-omitempty": true }, "PowerOnHoursPercentage": { "description": "Percentage of life used based on five year life span of Cisco supported drives.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "PredictedMediaLifeLeftPercent": { "description": "Predicted physical disk life left in percentage.", "type": "integer", "format": "int64", "x-omitempty": true }, "PredictiveFailureCount": { "description": "Error count on the physical disk.", "type": "integer", "format": "int64", "x-omitempty": true }, "Protocol": { "description": "This field identifies the disk protocol used for communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "RawSize": { "description": "The raw size of the physical disk in MB.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReadErrorCountThreshold": { "description": "The number of read errors that are permitted while accessing the drive/card.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ReadIoErrorCount": { "description": "Number of IO Errors that occured while reading data from the disk.", "type": "integer", "format": "int64", "x-omitempty": true }, "Secured": { "description": "This field identifies whether the disk is encrypted.", "type": "string", "x-omitempty": true }, "Size": { "description": "The size of the physical disk in MB.", "type": "string", "readOnly": true, "x-omitempty": true }, "Thermal": { "description": "Thermal state of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "ThresholdOperatingTemperature": { "description": "Rated threshold operating temperature in Celsius.", "type": "integer", "format": "int64", "x-omitempty": true }, "Type": { "description": "This field identifies the type of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "VariantType": { "description": "The variant type of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "WearStatusInDays": { "description": "The number of days an SSD has gone through with the write cycles.", "type": "integer", "format": "int64", "x-omitempty": true }, "WriteErrorCountThreshold": { "description": "The number of write errors that are permitted while accessing the drive/card.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "WriteIoErrorCount": { "description": "Number of IO Errors that occured while writing data to the disk.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LocatorLed": { "$ref": "#/components/schemas/equipment.LocatorLed.Relationship", "description": "A reference to a equipmentLocatorLed resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDiskExtensions": { "description": "An array of relationships to storagePhysicalDiskExtension resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RunningFirmware": { "description": "An array of relationships to firmwareRunningFirmware resources.", "type": "array", "items": { "$ref": "#/components/schemas/firmware.RunningFirmware.Relationship" }, "nullable": true, "readOnly": true }, "SasPorts": { "description": "An array of relationships to storageSasPort resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.SasPort.Relationship" }, "nullable": true, "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageEnclosure": { "$ref": "#/components/schemas/storage.Enclosure.Relationship", "description": "A reference to a storageEnclosure resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PhysicalDisk.List": { "title": "List of 'storage.PhysicalDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PhysicalDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PhysicalDisk' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDisk" }, "nullable": true } } } ] }, "storage.PhysicalDiskExtension.Response": { "description": "The response body of a HTTP GET request for the 'storage.PhysicalDiskExtension' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PhysicalDiskExtension' resources.", "x-one-of-name": "storage.PhysicalDiskExtension.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.PhysicalDiskExtension.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PhysicalDiskExtension.Relationship": { "description": "A relationship to the 'storage.PhysicalDiskExtension' resource, or the expanded 'storage.PhysicalDiskExtension' resource, or the 'null' value.", "x-one-of-name": "storage.PhysicalDiskExtension.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PhysicalDiskExtension": { "title": "Storage:Physical Disk Extension", "description": "Information of disks as reported by controller. In certain cases like S-series servers, disk information will be reported by controller separately and this represents such information.", "x-allOf-name": "storage.PhysicalDiskExtension", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PhysicalDiskExtension', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PhysicalDiskExtension" ], "default": "storage.PhysicalDiskExtension", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PhysicalDiskExtension" ], "default": "storage.PhysicalDiskExtension", "x-enum-as-string": true }, "Bootable": { "description": "The whether disk is bootable or not.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskDn": { "description": "The distinguished name of the Physical drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskId": { "description": "The storage Enclosure slotId.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DiskState": { "description": "The current drive state of disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Health": { "description": "The current drive state of disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PhysicalDiskExtension.List": { "title": "List of 'storage.PhysicalDiskExtension' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PhysicalDiskExtension' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PhysicalDiskExtension' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDiskExtension" }, "nullable": true } } } ] }, "storage.PhysicalDiskUsage.Response": { "description": "The response body of a HTTP GET request for the 'storage.PhysicalDiskUsage' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PhysicalDiskUsage' resources.", "x-one-of-name": "storage.PhysicalDiskUsage.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.PhysicalDiskUsage.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PhysicalDiskUsage.Relationship": { "description": "A relationship to the 'storage.PhysicalDiskUsage' resource, or the expanded 'storage.PhysicalDiskUsage' resource, or the 'null' value.", "x-one-of-name": "storage.PhysicalDiskUsage.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PhysicalDiskUsage": { "title": "Storage:Physical Disk Usage", "description": "Has usage map between physical disks and virtual drives.", "x-allOf-name": "storage.PhysicalDiskUsage", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PhysicalDiskUsage', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PhysicalDiskUsage" ], "default": "storage.PhysicalDiskUsage", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PhysicalDiskUsage" ], "default": "storage.PhysicalDiskUsage", "x-enum-as-string": true }, "NumberOfBlocks": { "description": "The number of blocks that are a part of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "PhysicalDrive": { "description": "The physical disk for which the usage is reported.", "type": "string", "readOnly": true, "x-omitempty": true }, "Span": { "description": "The span of the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "StartingBlock": { "description": "The starting block id of the virtual drive within the physical drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "State": { "description": "The current state of the physical disk usage.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualDrive": { "description": "The virtual drive corresponding to the physical disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageVirtualDrive": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship", "description": "A reference to a storageVirtualDrive resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.PhysicalDiskUsage.List": { "title": "List of 'storage.PhysicalDiskUsage' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PhysicalDiskUsage' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PhysicalDiskUsage' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage" }, "nullable": true } } } ] }, "storage.PureArray.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureArray' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureArray' resources.", "x-one-of-name": "storage.PureArray.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureArray.Relationship": { "description": "A relationship to the 'storage.PureArray' resource, or the expanded 'storage.PureArray' resource, or the 'null' value.", "x-one-of-name": "storage.PureArray.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureArray": { "title": "Storage:Pure Array", "description": "The details of the Pure storage array.", "x-allOf-name": "storage.PureArray", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArray" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureArray" ], "default": "storage.PureArray", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureArray" ], "default": "storage.PureArray", "x-enum-as-string": true }, "ApiVersion": { "description": "Major version of REST API supported by the Pure storage array. Will be used as constraint for implementation tasks. If REST API version is less than 2.4, then this property returns the major version 1, else returns 2.", "type": "string", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureArray.List": { "title": "List of 'storage.PureArray' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureArray' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureArray' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray" }, "nullable": true } } } ] }, "storage.PureArrayAlerts.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureArrayAlerts' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureArrayAlerts' resources.", "x-one-of-name": "storage.PureArrayAlerts.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArrayAlerts.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureArrayAlerts": { "title": "Storage:Pure Array Alerts", "description": "Alert Events in PureStorage FlashArray.", "x-allOf-name": "storage.PureArrayAlerts", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureArrayAlerts', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureArrayAlerts" ], "default": "storage.PureArrayAlerts", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureArrayAlerts" ], "default": "storage.PureArrayAlerts", "x-enum-as-string": true }, "Cause": { "description": "Reason for the event generation.", "type": "string", "readOnly": true, "x-omitempty": true }, "Component": { "description": "Component for which the event generation.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreatedAt": { "description": "Date on which the event was generated on FlashArrays.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "ID of the alert related to the event.", "type": "string", "readOnly": true, "x-omitempty": true }, "Severity": { "description": "Type of the severity of the event it could be Critical or Warning.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureArrayAlerts.List": { "title": "List of 'storage.PureArrayAlerts' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureArrayAlerts' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureArrayAlerts' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArrayAlerts" }, "nullable": true } } } ] }, "storage.PureArrayUtilization": { "title": "Storage:Pure Array Utilization", "description": "Storage space consumption of Pure FlashArray.", "x-allOf-name": "storage.PureArrayUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureArrayUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureArrayUtilization" ], "default": "storage.PureArrayUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureArrayUtilization" ], "default": "storage.PureArrayUtilization", "x-enum-as-string": true }, "DataReduction": { "description": "Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5.0 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Parity": { "description": "Percentage of data that is fully protected. The percentage value will drop below 100% if the data is not fully protected.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Provisioned": { "description": "Total provisioned storage capacity in Pure FlashArray, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Shared": { "description": "Physical space occupied by deduplicated data, represented in bytes. The space is shared with other volumes and snapshots as a result of data deduplication.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Snapshot": { "description": "Physical space occupied by the snapshots, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "System": { "description": "Physical space occupied by internal array metadata, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ThinProvisioned": { "description": "Percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalReduction": { "description": "Ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10.0 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Volume": { "description": "Physical space occupied by volume data, excluding shared, array metadata and snapshots. Size is represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.PureBlade.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureBlade' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureBlade' resources.", "x-one-of-name": "storage.PureBlade.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureBlade.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureBlade": { "title": "Storage:Pure Blade", "description": "The PureBlade object models a blade hardware component within a PureStorage FlashBlade array. This provides foundational support for hardware inventory and blade-level management.\n#### Purpose\nPureBlade is intended to represent individual hardware blades, aiding administrators in monitoring blade health, status, and capacity. This ensures optimal performance and facilitates maintenance operations within the array.\n#### Key Concepts\n- **Hardware Inventory**: Enables granular tracking of blade components, supporting efficient asset and lifecycle management.\n- **Status Monitoring**: Facilitates real-time status checks and operational insights for each blade.\n- **Integration**: Connects blade data to the broader array and device registration infrastructure.\n- **Access Control**: Enforces privilege sets to ensure only authorized personnel can view or manage blade details.", "x-allOf-name": "storage.PureBlade", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureBlade', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureBlade" ], "default": "storage.PureBlade", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureBlade" ], "default": "storage.PureBlade", "x-enum-as-string": true }, "BladeId": { "description": "Unique identifier of the blade.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the blade within the FlashBlade array.", "type": "string", "readOnly": true, "x-omitempty": true }, "RawCapacity": { "description": "Raw storage capacity of the blade in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Operational status of the blade.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Relationship", "description": "A reference to a storagePureFlashBladeSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureBlade.List": { "title": "List of 'storage.PureBlade' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureBlade' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureBlade' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureBlade" }, "nullable": true } } } ] }, "storage.PureController.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureController' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureController' resources.", "x-one-of-name": "storage.PureController.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureController.Relationship": { "description": "A relationship to the 'storage.PureController' resource, or the expanded 'storage.PureController' resource, or the 'null' value.", "x-one-of-name": "storage.PureController.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureController": { "title": "Storage:Pure Controller", "description": "The PureController object represents a storage controller within a PureStorage FlashArray, managing data flow and operations. \n#### Purpose \nPureController facilitates the management of storage controllers, ensuring efficient data operations and resource allocation within the FlashArray. \n#### Key Concepts \n- **Controller Management:** Offers structured management of storage controllers, optimizing data flow and operations. \n- **Integration:** Supports integration with array and port objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage storage controllers within the storage network.", "x-allOf-name": "storage.PureController", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayController" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureController', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureController" ], "default": "storage.PureController", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureController" ], "default": "storage.PureController", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureController.List": { "title": "List of 'storage.PureController' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureController' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureController' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController" }, "nullable": true } } } ] }, "storage.PureDirectory.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDirectory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDirectory' resources.", "x-one-of-name": "storage.PureDirectory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDirectory.Relationship": { "description": "A relationship to the 'storage.PureDirectory' resource, or the expanded 'storage.PureDirectory' resource, or the 'null' value.", "x-one-of-name": "storage.PureDirectory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureDirectory": { "title": "Storage:Pure Directory", "description": "The PureDirectory object represents a managed directory within a PureStorage FlashArray, offering space reporting and metrics.\n#### Purpose \nPureDirectory facilitates the organization and management of storage directories, providing structured space reporting and policy integration within the FlashArray. \n#### Key Concepts \n- **Directory Management:** Offers structured management of directories, optimizing space reporting and storage operations. \n- **Policy Integration:** Supports attachment of policies to directories, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage directory operations within the storage network.", "x-allOf-name": "storage.PureDirectory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDirectory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDirectory" ], "default": "storage.PureDirectory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDirectory" ], "default": "storage.PureDirectory", "x-enum-as-string": true }, "CreatedTime": { "description": "The managed directory creation time, measured in milliseconds since the UNIX epoch.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DataReduction": { "description": "The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "A boolean value, if set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DirectoryName": { "description": "The managed directory name without the file system name prefix.", "type": "string", "readOnly": true, "x-omitempty": true }, "ExportPolicyList": { "type": "array", "items": { "description": "Names of the export policies which are associated with the directory.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "FileSystemName": { "description": "Name of file syetem associated with the directory.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemberName": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "MemberResourceType": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "A user-specified name. The name must be locally unique and can be changed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyResourceType": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuotaPolicyNames": { "type": "array", "items": { "description": "Names of the quota policies which are associated with the directory.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Snapshots": { "description": "The physical space occupied by data unique to one or more snapshots. Measured in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ThinProvisioning": { "description": "The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalPhysical": { "description": "The total physical space occupied by system, shared space, volume, and snapshot data. Measured in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalReduction": { "description": "The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalUsed": { "description": "The total space contributed by customer data, measured in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Unique": { "description": "The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExportPolicies": { "description": "An array of relationships to storagePureDirectoryExport resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport.Relationship" }, "nullable": true, "readOnly": true }, "FileSystems": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems.Relationship", "description": "A reference to a storagePureFileSystems resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "QuotaPolicies": { "description": "An array of relationships to storagePureDirectoryQuota resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureDirectory.List": { "title": "List of 'storage.PureDirectory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDirectory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDirectory' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory" }, "nullable": true } } } ] }, "storage.PureDirectoryExport.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDirectoryExport' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDirectoryExport' resources.", "x-one-of-name": "storage.PureDirectoryExport.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDirectoryExport.Relationship": { "description": "A relationship to the 'storage.PureDirectoryExport' resource, or the expanded 'storage.PureDirectoryExport' resource, or the 'null' value.", "x-one-of-name": "storage.PureDirectoryExport.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureDirectoryExport": { "title": "Storage:Pure Directory Export", "description": "The PureDirectoryExport object facilitates the creation of managed directory exports within a PureStorage FlashArray, enhancing data accessibility. \n#### Purpose \nPureDirectoryExport provides a mechanism for exporting directories, enabling efficient data access and integration with supported protocols.\n#### Key Concepts \n- **Export Management:** Facilitates the creation and management of directory exports, optimizing data accessibility and integration. \n- **Protocol Support:** Supports integration with NFS and SMB protocols, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage directory exports within the storage network.", "x-allOf-name": "storage.PureDirectoryExport", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDirectoryExport', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDirectoryExport" ], "default": "storage.PureDirectoryExport", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDirectoryExport" ], "default": "storage.PureDirectoryExport", "x-enum-as-string": true }, "Destroyed": { "description": "Returns a value of true if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DirectoryName": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "DirectoryResourceType": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Returns a value of true if the export policy that manages this export is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The export name for accessing this export.", "type": "string", "readOnly": true, "x-omitempty": true }, "Path": { "description": "The path of the exported managed directory.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "The export policy that manages this export. An export can be managed by at most one export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyResourceType": { "description": "The export policy that manages this export. An export can be managed by at most one export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Directory": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory.Relationship", "description": "A reference to a storagePureDirectory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Relationship", "description": "A reference to a storagePureDirectoryPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureDirectoryExport.List": { "title": "List of 'storage.PureDirectoryExport' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDirectoryExport' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDirectoryExport' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport" }, "nullable": true } } } ] }, "storage.PureDirectoryPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDirectoryPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDirectoryPolicy' resources.", "x-one-of-name": "storage.PureDirectoryPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDirectoryPolicy.Relationship": { "description": "A relationship to the 'storage.PureDirectoryPolicy' resource, or the expanded 'storage.PureDirectoryPolicy' resource, or the 'null' value.", "x-one-of-name": "storage.PureDirectoryPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureDirectoryPolicy": { "title": "Storage:Pure Directory Policy", "description": "Displays a list of policies that are attached to directories.", "x-allOf-name": "storage.PureDirectoryPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDirectoryPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDirectoryPolicy" ], "default": "storage.PureDirectoryPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDirectoryPolicy" ], "default": "storage.PureDirectoryPolicy", "x-enum-as-string": true }, "Destroyed": { "description": "Returns a value of true if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Returns a value of true if the export policy that manages this export is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The export name for accessing this export.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyType": { "description": "The export policy that manages this export. An export can be managed by at most one export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ExportMembers": { "description": "An array of relationships to storagePureDirectoryExport resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryExport.Relationship" }, "nullable": true, "readOnly": true }, "NfsRules": { "description": "An array of relationships to storagePureNfsPolicyRule resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule.Relationship" }, "nullable": true, "readOnly": true }, "QuotaMembers": { "description": "An array of relationships to storagePureDirectoryQuota resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota.Relationship" }, "nullable": true, "readOnly": true }, "QuotaRules": { "description": "An array of relationships to storagePureQuotaPolicyRule resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SmbRules": { "description": "An array of relationships to storagePureSmbPolicyRule resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.PureDirectoryPolicy.List": { "title": "List of 'storage.PureDirectoryPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDirectoryPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDirectoryPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy" }, "nullable": true } } } ] }, "storage.PureDirectoryQuota.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDirectoryQuota' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDirectoryQuota' resources.", "x-one-of-name": "storage.PureDirectoryQuota.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDirectoryQuota.Relationship": { "description": "A relationship to the 'storage.PureDirectoryQuota' resource, or the expanded 'storage.PureDirectoryQuota' resource, or the 'null' value.", "x-one-of-name": "storage.PureDirectoryQuota.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureDirectoryQuota": { "title": "Storage:Pure Directory Quota", "description": "The PureDirectoryQuota object represents quota policies within a PureStorage FlashArray, ensuring organized and efficient storage operations. \n#### Purpose \nPureDirectoryQuota facilitates the management of quota policies, providing structured control and allocation of storage resources within the FlashArray. \n#### Key Concepts \n- **Quota Management:** Offers structured management of quotas, optimizing storage operations and resource allocation. \n- **Integration:** Supports integration with directory objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage quota policies within the storage network.", "x-allOf-name": "storage.PureDirectoryQuota", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDirectoryQuota', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDirectoryQuota" ], "default": "storage.PureDirectoryQuota", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDirectoryQuota" ], "default": "storage.PureDirectoryQuota", "x-enum-as-string": true }, "Destroyed": { "description": "Returns a value of true if the managed directory of the export has been destroyed and is pending eradication. The export can be recovered by recovering the destroyed managed directory.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "DirectoryName": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "DirectoryResourceType": { "description": "Absolute path of the managed directory in the file system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Returns a value of true if the export policy that manages this export is enabled.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "The export policy that manages this export. An export can be managed by at most one export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyResourceType": { "description": "The export policy that manages this export. An export can be managed by at most one export policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Directory": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory.Relationship", "description": "A reference to a storagePureDirectory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Relationship", "description": "A reference to a storagePureDirectoryPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureDirectoryQuota.List": { "title": "List of 'storage.PureDirectoryQuota' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDirectoryQuota' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDirectoryQuota' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryQuota" }, "nullable": true } } } ] }, "storage.PureDirectorySnapshot.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDirectorySnapshot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDirectorySnapshot' resources.", "x-one-of-name": "storage.PureDirectorySnapshot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectorySnapshot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDirectorySnapshot": { "title": "Storage:Pure Directory Snapshot", "description": "The PureDirectorySnapshot object represents snapshots of directories within a PureStorage FlashArray, ensuring organized data backup and recovery. \n#### Purpose \nPureDirectorySnapshot facilitates the creation and management of directory snapshots, providing structured data protection and recovery processes within the FlashArray. \n#### Key Concepts \n- **Snapshot Management:** Offers structured management of directory snapshots, optimizing data backup and recovery operations. \n- **Policy Integration:** Supports integration with snapshot policies, enhancing data protection capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage directory snapshots within the storage network.", "x-allOf-name": "storage.PureDirectorySnapshot", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDirectorySnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDirectorySnapshot" ], "default": "storage.PureDirectorySnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDirectorySnapshot" ], "default": "storage.PureDirectorySnapshot", "x-enum-as-string": true }, "ClientName": { "description": "The customizable portion of the client-visible snapshot name. A full snapshot name is constructed in the form of DIR.CLIENT_NAME.SUFFIX where DIR is the full managed directory name, CLIENT_NAME is the client name, and SUFFIX is the suffix. The client-visible snapshot name is CLIENT_NAME.SUFFIX.", "type": "string", "readOnly": true, "x-omitempty": true }, "CreatedTime": { "description": "The snapshot creation time, measured in milliseconds since the UNIX epoch.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "A user-specified name. The name must be locally unique and can be changed.", "type": "string", "readOnly": true, "x-omitempty": true }, "Source": { "description": "The directory from which this snapshot was taken.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Directory": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectory.Relationship", "description": "A reference to a storagePureDirectory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureDirectorySnapshot.List": { "title": "List of 'storage.PureDirectorySnapshot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDirectorySnapshot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDirectorySnapshot' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectorySnapshot" }, "nullable": true } } } ] }, "storage.PureDisk.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureDisk' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureDisk' resources.", "x-one-of-name": "storage.PureDisk.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDisk.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureDisk": { "title": "Storage:Pure Disk", "description": "Disk entity associated with Pure FlashArray.", "x-allOf-name": "storage.PureDisk", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArrayDisk" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureDisk', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureDisk" ], "default": "storage.PureDisk", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureDisk" ], "default": "storage.PureDisk", "x-enum-as-string": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureDisk.List": { "title": "List of 'storage.PureDisk' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureDisk' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureDisk' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDisk" }, "nullable": true } } } ] }, "storage.PureDiskUtilization": { "title": "Storage:Pure Disk Utilization", "description": "The PureDisk object represents a disk entity within a PureStorage FlashArray, serving as a fundamental unit for storage capacity. \n#### Purpose \nPureDisk facilitates the management of storage disks, providing structured control and allocation of storage resources within the FlashArray. \n#### Key Concepts \n- **Disk Management:** Offers structured management of disks, optimizing storage operations and resource allocation. \n- **Integration:** Supports integration with array objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage disk operations within the storage network.", "x-allOf-name": "storage.PureDiskUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" } ] }, "storage.PureFileSystems.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureFileSystems' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureFileSystems' resources.", "x-one-of-name": "storage.PureFileSystems.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureFileSystems.Relationship": { "description": "A relationship to the 'storage.PureFileSystems' resource, or the expanded 'storage.PureFileSystems' resource, or the 'null' value.", "x-one-of-name": "storage.PureFileSystems.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureFileSystems": { "title": "Storage:Pure File Systems", "description": "The PureFileSystems object represents a filesystem within a PureStorage FlashArray, serving as a fundamental unit for organizing storage resources. \n#### Purpose \nPureFileSystems provides a mechanism for managing and organizing storage resources, ensuring efficient and secure data operations within the FlashArray. \n#### Key Concepts \n- **Filesystem Management:** It offers structured management of filesystems, optimizing storage operations and resource allocation. \n- **Directory Integration:** Supports integration with directories and export policies, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage filesystem operations within the storage network.", "x-allOf-name": "storage.PureFileSystems", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureFileSystems', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureFileSystems" ], "default": "storage.PureFileSystems", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureFileSystems" ], "default": "storage.PureFileSystems", "x-enum-as-string": true }, "CreatedTime": { "description": "The file system creation time, measured in milliseconds since the UNIX epoch.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "A boolean value, if set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pod": { "description": "The reference to the pod the file systems belongs to, or null if it is not in a pod.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureFileSystems.List": { "title": "List of 'storage.PureFileSystems' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureFileSystems' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureFileSystems' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFileSystems" }, "nullable": true } } } ] }, "storage.PureFlashBladeFileSystem.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureFlashBladeFileSystem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureFlashBladeFileSystem' resources.", "x-one-of-name": "storage.PureFlashBladeFileSystem.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeFileSystem.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureFlashBladeFileSystem": { "title": "Storage:Pure Flash Blade File System", "description": "The PureFlashBladeFileSystem object represents a file system entity within the PureStorage FlashBlade array. It is a foundational model for organizing and managing file-based storage resources.\n#### Purpose\nPureFlashBladeFileSystem is designed to facilitate the creation, monitoring, and management of file systems, supporting quota limits, replication status, and utilization tracking within the FlashBlade environment.\n#### Key Concepts\n- **File System Management**: Enables structured organization and oversight of file-based storage, including quotas and writable status.\n- **Replication Support**: Integrates promotion status for replicated file systems, supporting disaster recovery and high availability.\n- **Utilization Metrics**: Tracks space usage for resource planning and optimization.\n- **Relationship Mapping**: Connects file systems to their storage arrays and device registrations for seamless integration.", "x-allOf-name": "storage.PureFlashBladeFileSystem", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureFlashBladeFileSystem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureFlashBladeFileSystem" ], "default": "storage.PureFlashBladeFileSystem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureFlashBladeFileSystem" ], "default": "storage.PureFlashBladeFileSystem", "x-enum-as-string": true }, "CreatedTime": { "description": "Creation timestamp of the file system.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "Returns a value of true if the file system has been destroyed and is pending eradication. The file system cannot be modified while it is in the destroyed state.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "FileSystemId": { "description": "A non-modifiable, globally unique ID chosen by the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "HardLimitEnabled": { "description": "If set to true, the file system's size, as defined by provisioned, is used as a hard limit quota.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the object (e.g., a file system or snapshot).", "type": "string", "readOnly": true, "x-omitempty": true }, "PromotionStatus": { "description": "The current status of the file system with respect to replication. Possible values are promoted and demoted.", "type": "string", "readOnly": true, "x-omitempty": true }, "Provisioned": { "description": "The provisioned size of the file system, displayed in bytes. If set to an empty string, the file system is unlimited in size.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "The space usage of the file system.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeUtilization", "readOnly": true, "x-omitempty": true }, "Writable": { "description": "Whether the file system is writable or not. If false, this overrides any protocol or file permission settings and prevents changes.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Relationship", "description": "A reference to a storagePureFlashBladeSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureFlashBladeFileSystem.List": { "title": "List of 'storage.PureFlashBladeFileSystem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureFlashBladeFileSystem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureFlashBladeFileSystem' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeFileSystem" }, "nullable": true } } } ] }, "storage.PureFlashBladeSystem.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureFlashBladeSystem' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureFlashBladeSystem' resources.", "x-one-of-name": "storage.PureFlashBladeSystem.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureFlashBladeSystem.Relationship": { "description": "A relationship to the 'storage.PureFlashBladeSystem' resource, or the expanded 'storage.PureFlashBladeSystem' resource, or the 'null' value.", "x-one-of-name": "storage.PureFlashBladeSystem.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureFlashBladeSystem": { "title": "Storage:Pure Flash Blade System", "description": "The PureFlashBladeSystem object represents the details of a Pure FlashBlade storage system, serving as the primary model for managing and monitoring array-level attributes and operations within the PureStorage ecosystem.\n#### Purpose\nPureFlashBladeSystem is designed to capture the essential characteristics and operational status of a FlashBlade storage array. This provides customers with a unified overview of the array, supporting inventory, utilization tracking, and integration with management platforms.\n#### Key Concepts\n- **Array Inventory**: Enables comprehensive tracking and identification of FlashBlade arrays, supporting efficient asset management.\n- **Utilization Monitoring**: Facilitates real-time visibility into file system and object store utilization for optimal resource allocation.\n- **Integration** : Seamlessly connects to external management systems, allowing for consistent monitoring and updates.\n- **Access Control**: Ensures secure access through privilege sets and licensing, safeguarding critical storage operations.", "x-allOf-name": "storage.PureFlashBladeSystem", "allOf": [ { "$ref": "#/components/schemas/storage.BaseArray" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureFlashBladeSystem', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureFlashBladeSystem" ], "default": "storage.PureFlashBladeSystem", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureFlashBladeSystem" ], "default": "storage.PureFlashBladeSystem", "x-enum-as-string": true }, "FileSystem": { "description": "Storage utilization for file systems on the FlashBlade array.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeUtilization", "readOnly": true, "x-omitempty": true }, "ObjectStore": { "description": "Storage utilization for object store (buckets) on the FlashBlade array.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeUtilization", "readOnly": true, "x-omitempty": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureFlashBladeSystem.List": { "title": "List of 'storage.PureFlashBladeSystem' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureFlashBladeSystem' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureFlashBladeSystem' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem" }, "nullable": true } } } ] }, "storage.PureFlashBladeUtilization": { "title": "Storage:Pure Flash Blade Utilization", "description": "Storage space consumption of Pure FlashBlade.", "x-allOf-name": "storage.PureFlashBladeUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureFlashBladeUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureFlashBladeUtilization" ], "default": "storage.PureFlashBladeUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureFlashBladeUtilization" ], "default": "storage.PureFlashBladeUtilization", "x-enum-as-string": true }, "AvailableProvisioned": { "description": "The amount of space left that the current object can grow before writes are stopped due to a hard limit quota being hit. The value is total_provisioned minus the virtual space used.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "AvailableRatio": { "description": "The ratio of the available space versus the total provisioned space.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "DataReduction": { "description": "Reduction of data. Ratio of mapped sectors versus the amount of physical space the data occupies after data compression and deduplication.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "Unique physical space (excluding snapshots) occupied by destroyed data within the child containers, in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DestroyedVirtual": { "description": "The amount of destroyed logically written data within the child containers, in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Parity": { "description": "A representation of data redundancy on the array. Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Snapshot": { "description": "Physical usage by snapshots, other than unique in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalProvisioned": { "description": "The effective provisioned size of the container, at which a hard limit will be applied. For the array, this is the sum of the file systems and accounts. Measured in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Unique": { "description": "Unique physical space occupied by customer data, in bytes. Excludes shared space, snapshots, and metadata.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Virtual": { "description": "Logically consumed space for the object, in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.PureHost.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureHost' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureHost' resources.", "x-one-of-name": "storage.PureHost.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureHost.Relationship": { "description": "A relationship to the 'storage.PureHost' resource, or the expanded 'storage.PureHost' resource, or the 'null' value.", "x-one-of-name": "storage.PureHost.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureHost": { "title": "Storage:Pure Host", "description": "A host entity in PureStorage FlashArray. It is an abstraction used by PureStorage to organize\nthe storage network addresses (Fibre Channel worldwide names or iSCSI qualified names)\nof client computers and to control communications between clients and volumes.", "x-allOf-name": "storage.PureHost", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHost" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureHost', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureHost" ], "default": "storage.PureHost", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureHost" ], "default": "storage.PureHost", "x-enum-as-string": true }, "HostGroupName": { "description": "Name of host group where the host belongs to. Empty if host is not part of any HostGroup.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "HostGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup.Relationship", "description": "A reference to a storagePureHostGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureHost.List": { "title": "List of 'storage.PureHost' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureHost' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureHost' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost" }, "nullable": true } } } ] }, "storage.PureHostGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureHostGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureHostGroup' resources.", "x-one-of-name": "storage.PureHostGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureHostGroup.Relationship": { "description": "A relationship to the 'storage.PureHostGroup' resource, or the expanded 'storage.PureHostGroup' resource, or the 'null' value.", "x-one-of-name": "storage.PureHostGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureHostGroup": { "title": "Storage:Pure Host Group", "description": "The PureHostGroup object represents a collection of hosts within a PureStorage FlashArray, facilitating common connectivity to storage volumes. \n#### Purpose \nPureHostGroup is used to manage and establish shared connections between hosts and volumes, ensuring efficient access and data sharing across multiple hosts. \n#### Key Concepts \n- **Group Connectivity:** PureHostGroup allows hosts within the group to access volumes through shared connections, streamlining data access and communication. \n- **Access Management:** It supports various privilege sets to control and secure interactions with storage volumes. \n- **Integration:** PureHostGroup integrates with other objects such as PureVolume and PureHost, providing a cohesive storage management solution.", "x-allOf-name": "storage.PureHostGroup", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHostGroup" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureHostGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureHostGroup" ], "default": "storage.PureHostGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureHostGroup" ], "default": "storage.PureHostGroup", "x-enum-as-string": true }, "HostNames": { "type": "array", "items": { "description": "Names of the host which are associated with the host group.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Hosts": { "description": "An array of relationships to storagePureHost resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.Relationship" }, "nullable": true, "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureHostGroup.List": { "title": "List of 'storage.PureHostGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureHostGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureHostGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup" }, "nullable": true } } } ] }, "storage.PureHostLun.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureHostLun' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureHostLun' resources.", "x-one-of-name": "storage.PureHostLun.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostLun.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureHostLun": { "title": "Storage:Pure Host Lun", "description": "The PureHostLun object represents a logical unit number (LUN) in a PureStorage FlashArray, existing only if a volume is connected to a host or host group. \n#### Purpose \nPureHostLun serves to manage the logical connections between volumes and hosts, ensuring organized data access and storage operations within the FlashArray. \n#### Key Concepts \n- **LUN Management:** PureHostLun provides a mechanism for organizing volume connections, facilitating efficient data access. \n- **Connection Type:** It distinguishes between shared connections (via host groups) and direct host connections, optimizing communication pathways. \n- **Secure Access:** PureHostLun employs privilege sets to ensure secure management of LUNs within the storage array.", "x-allOf-name": "storage.PureHostLun", "allOf": [ { "$ref": "#/components/schemas/storage.BaseHostLun" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureHostLun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureHostLun" ], "default": "storage.PureHostLun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureHostLun" ], "default": "storage.PureHostLun", "x-enum-as-string": true }, "HostGroupName": { "description": "Name of the host group associated with LUN.", "type": "string", "readOnly": true, "x-omitempty": true }, "Shared": { "description": "Kind of volume connection to host. True if it is connected through host group. False in case of direct host connection.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Host": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.Relationship", "description": "A reference to a storagePureHost resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "HostGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup.Relationship", "description": "A reference to a storagePureHostGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volume": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Relationship", "description": "A reference to a storagePureVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureHostLun.List": { "title": "List of 'storage.PureHostLun' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureHostLun' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureHostLun' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostLun" }, "nullable": true } } } ] }, "storage.PureHostUtilization": { "title": "Storage:Pure Host Utilization", "description": "The PureHost object is an abstraction within PureStorage FlashArray that organizes the storage network addresses of client computers, facilitating communication between clients and volumes. \n#### Purpose \nPureHost serves to manage the connections and interactions between client computers and storage volumes, ensuring efficient data access and communication within the storage network. \n#### Key Concepts \n- **Address Management:** PureHost helps organize and control storage network addresses, optimizing connectivity and communication. \n- **Shared Connectivity:** It enables shared connections between hosts and volumes, allowing multiple clients to access data efficiently. \n- **Security:** PureHost utilizes privilege sets to ensure secure access and operations within the storage network.", "x-allOf-name": "storage.PureHostUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.StorageUtilization" } ] }, "storage.PureManagementAccessPolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureManagementAccessPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureManagementAccessPolicy' resources.", "x-one-of-name": "storage.PureManagementAccessPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureManagementAccessPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureManagementAccessPolicy": { "title": "Storage:Pure Management Access Policy", "description": "Displays a list of policies that define management access rules and privileges.", "x-allOf-name": "storage.PureManagementAccessPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureManagementAccessPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureManagementAccessPolicy" ], "default": "storage.PureManagementAccessPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureManagementAccessPolicy" ], "default": "storage.PureManagementAccessPolicy", "x-enum-as-string": true }, "AggregationStrategy": { "description": "The strategy used to combine the effects of multiple rules in this policy (e.g., 'deny-override').", "type": "string", "readOnly": true, "x-omitempty": true }, "Enabled": { "description": "Returns a value of true if the management access policy is currently active and enforced.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the management access policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyType": { "description": "The type of policy, typically 'management-access'.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureManagementAccessPolicy.List": { "title": "List of 'storage.PureManagementAccessPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureManagementAccessPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureManagementAccessPolicy' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureManagementAccessPolicy" }, "nullable": true } } } ] }, "storage.PureNfsPolicyRule.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureNfsPolicyRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureNfsPolicyRule' resources.", "x-one-of-name": "storage.PureNfsPolicyRule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureNfsPolicyRule.Relationship": { "description": "A relationship to the 'storage.PureNfsPolicyRule' resource, or the expanded 'storage.PureNfsPolicyRule' resource, or the 'null' value.", "x-one-of-name": "storage.PureNfsPolicyRule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureNfsPolicyRule": { "title": "Storage:Pure Nfs Policy Rule", "description": "The PureNfsPolicyRule object represents NFS policy rules within a PureStorage FlashArray, facilitating structured management of storage operations. \n#### Purpose \nPureNfsPolicyRule provides a mechanism for managing NFS policies, ensuring organized and efficient storage operations within the FlashArray. \n#### Key Concepts \n- **Policy Management:** Facilitates the creation and management of NFS policy rules, optimizing storage operations and resource allocation. \n- **Integration:** Supports integration with directory objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage NFS policy rules within the storage network.", "x-allOf-name": "storage.PureNfsPolicyRule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureNfsPolicyRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureNfsPolicyRule" ], "default": "storage.PureNfsPolicyRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureNfsPolicyRule" ], "default": "storage.PureNfsPolicyRule", "x-enum-as-string": true }, "Access": { "description": "Access of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Anongid": { "description": "Anongid of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Anonuid": { "description": "Anonuid of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Client": { "description": "Client of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "A boolean value, if set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the NFS policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "NfsVersion": { "type": "array", "items": { "description": "NFS version of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Permission": { "description": "Permission of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "Name of the NFS policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Security": { "type": "array", "items": { "description": "Security of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Relationship", "description": "A reference to a storagePureDirectoryPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureNfsPolicyRule.List": { "title": "List of 'storage.PureNfsPolicyRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureNfsPolicyRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureNfsPolicyRule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureNfsPolicyRule" }, "nullable": true } } } ] }, "storage.PureObjectBucket.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureObjectBucket' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureObjectBucket' resources.", "x-one-of-name": "storage.PureObjectBucket.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectBucket.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureObjectBucket": { "title": "Storage:Pure Object Bucket", "description": "The **PureObjectBucket** object represents a volume entity within PureStorage FlashBlade, specifically modeling object buckets used for storing and organizing data in object store environments.\n#### Purpose\nPureObjectBucket provides a structured abstraction for managing object buckets, enabling customers to efficiently handle storage, quotas, and data retention policies. It supports integration with object store accounts and arrays for comprehensive storage management.\n#### Key Concepts\n- **Object Store Management**: Supports the creation and organization of object buckets, facilitating scalable storage solutions.\n- **Quota and Retention**: Integrates quota limits and retention policies for robust data governance.\n- **Relationship Mapping**: Links buckets to their respective accounts and storage arrays, enhancing data traceability.\n- **Access Control**: Utilizes privilege sets to secure bucket operations and management.", "x-allOf-name": "storage.PureObjectBucket", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureObjectBucket', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureObjectBucket" ], "default": "storage.PureObjectBucket", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureObjectBucket" ], "default": "storage.PureObjectBucket", "x-enum-as-string": true }, "BucketName": { "description": "Name of the bucket within the object store account.", "type": "string", "readOnly": true, "x-omitempty": true }, "BucketType": { "description": "Type of the bucket (e.g., multi-site-writable).", "type": "string", "readOnly": true, "x-omitempty": true }, "Created": { "description": "Creation time of the bucket.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "Whether the bucket has been destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "HardLimitEnabled": { "description": "Whether the hard limit is enabled for the bucket.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Unique name of the bucket (combination of account name and bucket name).", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectCount": { "description": "Number of objects in the bucket.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ObjectStoreAccountName": { "description": "Name of the object store account that owns this bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuotaLimit": { "description": "Quota limit for the bucket in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "RetentionLock": { "description": "Retention lock status for the bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization for the bucket.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeUtilization", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "A globally unique identifier for the bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "Vendor": { "description": "Vendor of the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "Version": { "description": "Version of the FlashBlade array.", "type": "string", "readOnly": true, "x-omitempty": true }, "Versioning": { "description": "Versioning mode for the bucket.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Relationship", "description": "A reference to a storagePureFlashBladeSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ObjectStoreAccount": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount.Relationship", "description": "A reference to a storagePureObjectStoreAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureObjectBucket.List": { "title": "List of 'storage.PureObjectBucket' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureObjectBucket' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureObjectBucket' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectBucket" }, "nullable": true } } } ] }, "storage.PureObjectStoreAccount.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureObjectStoreAccount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureObjectStoreAccount' resources.", "x-one-of-name": "storage.PureObjectStoreAccount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureObjectStoreAccount.Relationship": { "description": "A relationship to the 'storage.PureObjectStoreAccount' resource, or the expanded 'storage.PureObjectStoreAccount' resource, or the 'null' value.", "x-one-of-name": "storage.PureObjectStoreAccount.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureObjectStoreAccount": { "title": "Storage:Pure Object Store Account", "description": "The PureObjectStoreAccount object models an account within the PureStorage FlashBlade object store. It is fundamental to the organization and management of buckets and users in object store environments.\n#### Purpose\nPureObjectStoreAccount provides a centralized abstraction for managing object store accounts, enabling quota control, utilization tracking, and relationship mapping to buckets and users.\n#### Key Concepts\n- **Account Management**: Offers robust capabilities for account creation, tracking, and quota enforcement.\n- **Utilization Monitoring**: Integrates storage utilization metrics for optimal resource planning.\n- **Relationship Mapping**: Links accounts to their buckets, users, and associated storage arrays.\n- **Access Control**: Privilege sets and licensing ensure secure and compliant account management.", "x-allOf-name": "storage.PureObjectStoreAccount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureObjectStoreAccount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureObjectStoreAccount" ], "default": "storage.PureObjectStoreAccount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureObjectStoreAccount" ], "default": "storage.PureObjectStoreAccount", "x-enum-as-string": true }, "Created": { "description": "Creation timestamp of the account.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "HardLimitEnabled": { "description": "If true, the account size defined by quotaLimit is used as a hard limit quota.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the object store account.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectCount": { "description": "The count of objects within the account.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "QuotaLimit": { "description": "The effective quota limit applied against the size of the account, displayed in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "The space specification of the account.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeUtilization", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "A non-modifiable, globally unique ID chosen by the system.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Relationship", "description": "A reference to a storagePureFlashBladeSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureObjectStoreAccount.List": { "title": "List of 'storage.PureObjectStoreAccount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureObjectStoreAccount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureObjectStoreAccount' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount" }, "nullable": true } } } ] }, "storage.PureObjectStoreUser.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureObjectStoreUser' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureObjectStoreUser' resources.", "x-one-of-name": "storage.PureObjectStoreUser.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreUser.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureObjectStoreUser": { "title": "Storage:Pure Object Store User", "description": "The PureObjectStoreUser object defines a user entity in the PureStorage FlashBlade object store context. It serves as a central point for managing access and user identities within object store accounts.\n#### Purpose\nPureObjectStoreUser is designed to facilitate secure user management in object store environments, allowing administrators to track user creation, association, and access within storage accounts.\n#### Key Concepts\n- **User Identity Management**: Provides a standardized model for user creation and association with object store accounts.\n- **Access Integration**: Links users to their accounts and arrays, supporting secure, multi-tenant environments.\n- **Privilege Enforcement**: Ensures only authorized personnel can view or modify user details.\n- **Audit Support**: Supports audit trails for user actions and associations within object stores.", "x-allOf-name": "storage.PureObjectStoreUser", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureObjectStoreUser', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureObjectStoreUser" ], "default": "storage.PureObjectStoreUser", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureObjectStoreUser" ], "default": "storage.PureObjectStoreUser", "x-enum-as-string": true }, "Created": { "description": "Creation time of the user.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the object store user.", "type": "string", "readOnly": true, "x-omitempty": true }, "ObjectStoreAccountName": { "description": "Name of the object store account that owns this user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "A globally unique identifier for the object store user.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureFlashBladeSystem.Relationship", "description": "A reference to a storagePureFlashBladeSystem resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ObjectStoreAccount": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreAccount.Relationship", "description": "A reference to a storagePureObjectStoreAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureObjectStoreUser.List": { "title": "List of 'storage.PureObjectStoreUser' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureObjectStoreUser' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureObjectStoreUser' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureObjectStoreUser" }, "nullable": true } } } ] }, "storage.PurePod.Response": { "description": "The response body of a HTTP GET request for the 'storage.PurePod' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PurePod' resources.", "x-one-of-name": "storage.PurePod.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PurePod.Relationship": { "description": "A relationship to the 'storage.PurePod' resource, or the expanded 'storage.PurePod' resource, or the 'null' value.", "x-one-of-name": "storage.PurePod.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PurePod": { "title": "Storage:Pure Pod", "description": "Logical containers used to group and manage volumes, protection groups, and configurations for mobility, replication, and multi-array management.", "x-allOf-name": "storage.PurePod", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PurePod', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PurePod" ], "default": "storage.PurePod", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PurePod" ], "default": "storage.PurePod", "x-enum-as-string": true }, "ArrayCount": { "description": "Number of arrays in the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "Indicates whether the pod has been destroyed and is pending eradication.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "LinkTargetCount": { "description": "Number of link targets in the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Mediator": { "description": "Name of the mediator managing synchronous replication between arrays.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the pod as configured on the Pure array.", "type": "string", "readOnly": true, "x-omitempty": true }, "PromotionStatus": { "description": "Promotion status of the pod. It can be one of the following values Promoting, Promoted, Demoted.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of pod entity in storage array.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePodUtilization", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroups": { "description": "An array of relationships to storagePureProtectionGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship" }, "nullable": true, "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volumes": { "description": "An array of relationships to storagePureVolume resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.PurePod.List": { "title": "List of 'storage.PurePod' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PurePod' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PurePod' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod" }, "nullable": true } } } ] }, "storage.PurePodUtilization": { "title": "Storage:Pure Pod Utilization", "description": "Storage space utilization of Pure FlashArray pod entity.", "x-allOf-name": "storage.PurePodUtilization", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PurePodUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PurePodUtilization" ], "default": "storage.PurePodUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PurePodUtilization" ], "default": "storage.PurePodUtilization", "x-enum-as-string": true }, "DataReduction": { "description": "Ratio of logical data to physical storage due to compression and deduplication only (excludes thin provisioning). For example, a ratio of 15.4 means 15.4 MB of logical data uses 1 MB of physical space.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Footprint": { "description": "Total physical space used by the pod on the array, including metadata overhead, snapshots, shared data, and system metadata.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Replication": { "description": "Amount of physical space used by replication activities for this pod. Value is 0 if replication is disabled.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Shared": { "description": "Amount of shared (deduplicated or referenced) data across volumes and snapshots in the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Snapshots": { "description": "Number of snapshot objects present within the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ThinProvisioning": { "description": "Efficiency ratio of thin provisioning. A value close to 1.0 indicates most provisioned space is used; a lower value indicates over-provisioning with less actual usage.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalPhysical": { "description": "Actual physical space consumed on flash by this pod's data. Equivalent to totalUsed.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalProvisioned": { "description": "Total logical size provisioned to volumes within the pod; amount of storage presented to hosts, regardless of how much is actually used.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalReduction": { "description": "The total data efficiency ratio achieved, factoring in both data reduction (compression and deduplication) and thin provisioning. For example, a ratio of 1800 means that 1800 units of logical data require only 1 unit of physical storage.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalUsed": { "description": "Total physical space used on the array by the pod, including unique, shared, and snapshot data.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Unique": { "description": "Amount of non-shared, unique data stored in the pod.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UsedProvisioned": { "description": "Amount of provisioned space that is currently being used by data written to volumes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Virtual": { "description": "The total amount of logical data written to the volumes in the pod, as seen by the hosts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.PurePort.Response": { "description": "The response body of a HTTP GET request for the 'storage.PurePort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PurePort' resources.", "x-one-of-name": "storage.PurePort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PurePort": { "title": "Storage:Pure Port", "description": "The PurePort object represents a port entity within a PureStorage FlashArray, facilitating network connectivity and data flow. \n#### Purpose \nPurePort facilitates the management of storage ports, ensuring efficient network connectivity and data operations within the FlashArray. \n#### Key Concepts \n- **Port Management:** Offers structured management of ports, optimizing network connectivity and data flow operations. \n- **Integration:** Supports integration with controller and array objects, enhancing storage management capabilities. \n - **Secure Access:** Utilizes privilege sets to secure and manage port operations within the storage network.", "x-allOf-name": "storage.PurePort", "allOf": [ { "$ref": "#/components/schemas/storage.BasePhysicalPort" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PurePort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PurePort" ], "default": "storage.PurePort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PurePort" ], "default": "storage.PurePort", "x-enum-as-string": true }, "Failover": { "description": "Name of the port to which this port has failed over.", "type": "string", "readOnly": true, "x-omitempty": true }, "Nqn": { "description": "The NVMe Qualified Name (NQN) associated with the host for ethernet port.", "type": "string", "readOnly": true, "x-omitempty": true }, "Portal": { "description": "Ip address of iSCSI portal configured on the port.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Controller": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureController.Relationship", "description": "A reference to a storagePureController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PurePort.List": { "title": "List of 'storage.PurePort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PurePort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PurePort' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePort" }, "nullable": true } } } ] }, "storage.PureProtectionGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureProtectionGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureProtectionGroup' resources.", "x-one-of-name": "storage.PureProtectionGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureProtectionGroup.Relationship": { "description": "A relationship to the 'storage.PureProtectionGroup' resource, or the expanded 'storage.PureProtectionGroup' resource, or the 'null' value.", "x-one-of-name": "storage.PureProtectionGroup.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureProtectionGroup": { "title": "Storage:Pure Protection Group", "description": "The PureProtectionGroup object is a critical element for managing data protection within a PureStorage FlashArray, facilitating volume protection through snapshots. \n#### Purpose \nPureProtectionGroup enables the protection of volumes by associating them with protection groups, ensuring data integrity and availability through snapshot creation. \n#### Key Concepts\n- **Snapshot Management:** PureProtectionGroup orchestrates the creation and management of snapshots, providing a robust mechanism for data protection. \n- **Volume Association:** It supports direct or indirect volume association, allowing flexible protection strategies within the FlashArray. \n- **Security:** Utilizes privilege sets to ensure secure access and management of protection groups.", "x-allOf-name": "storage.PureProtectionGroup", "allOf": [ { "$ref": "#/components/schemas/storage.BaseProtectionGroup" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureProtectionGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureProtectionGroup" ], "default": "storage.PureProtectionGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureProtectionGroup" ], "default": "storage.PureProtectionGroup", "x-enum-as-string": true }, "PodName": { "description": "A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "Overall size of all snapshots in the protection group, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Source": { "description": "Name of PureStorage array name on which the protection group is created.", "type": "string", "readOnly": true, "x-omitempty": true }, "Targets": { "type": "array", "items": { "description": "Target PureStorage array names where the replication snapshots are created.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "HostGroups": { "description": "An array of relationships to storagePureHostGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHostGroup.Relationship" }, "nullable": true, "readOnly": true }, "Hosts": { "description": "An array of relationships to storagePureHost resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.Relationship" }, "nullable": true, "readOnly": true }, "Pod": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod.Relationship", "description": "A reference to a storagePurePod resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volumes": { "description": "An array of relationships to storagePureVolume resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.PureProtectionGroup.List": { "title": "List of 'storage.PureProtectionGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureProtectionGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureProtectionGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup" }, "nullable": true } } } ] }, "storage.PureProtectionGroupSnapshot.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureProtectionGroupSnapshot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureProtectionGroupSnapshot' resources.", "x-one-of-name": "storage.PureProtectionGroupSnapshot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureProtectionGroupSnapshot.Relationship": { "description": "A relationship to the 'storage.PureProtectionGroupSnapshot' resource, or the expanded 'storage.PureProtectionGroupSnapshot' resource, or the 'null' value.", "x-one-of-name": "storage.PureProtectionGroupSnapshot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureProtectionGroupSnapshot": { "title": "Storage:Pure Protection Group Snapshot", "description": "The PureProtectionGroupSnapshot object represents a snapshot entity within a PureProtectionGroup, providing a mechanism for data backup and restoration. \n#### Purpose \nPureProtectionGroupSnapshot facilitates the creation and management of snapshots within protection groups, ensuring data integrity and recovery capabilities. \n#### Key Concepts \n- **Snapshot Management:** This provides structured management of snapshots, ensuring organized data backup and recovery processes. \n- **Integration:** PureProtectionGroupSnapshot integrates seamlessly with protection groups, offering a cohesive data protection strategy. \n- **Secure Access:** Employs privilege sets to control access and management of snapshots within the storage array.", "x-allOf-name": "storage.PureProtectionGroupSnapshot", "allOf": [ { "$ref": "#/components/schemas/storage.BaseProtectionGroupSnapshot" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureProtectionGroupSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureProtectionGroupSnapshot" ], "default": "storage.PureProtectionGroupSnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureProtectionGroupSnapshot" ], "default": "storage.PureProtectionGroupSnapshot", "x-enum-as-string": true }, "EradicationConfig": { "description": "The configuration of eradication feature.", "type": "string", "readOnly": true, "x-omitempty": true }, "Pod": { "description": "A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotSize": { "description": "The size of the snapshot created.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalProvisioned": { "description": "The overall size of the snapshot allocated by the storage array.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureProtectionGroupSnapshot.List": { "title": "List of 'storage.PureProtectionGroupSnapshot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureProtectionGroupSnapshot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureProtectionGroupSnapshot' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot" }, "nullable": true } } } ] }, "storage.PureQuotaPolicyRule.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureQuotaPolicyRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureQuotaPolicyRule' resources.", "x-one-of-name": "storage.PureQuotaPolicyRule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureQuotaPolicyRule.Relationship": { "description": "A relationship to the 'storage.PureQuotaPolicyRule' resource, or the expanded 'storage.PureQuotaPolicyRule' resource, or the 'null' value.", "x-one-of-name": "storage.PureQuotaPolicyRule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureQuotaPolicyRule": { "title": "Storage:Pure Quota Policy Rule", "description": "The PureQuotaPolicyRule object represents quota policy rules within a PureStorage FlashArray, ensuring organized and efficient storage operations. \n#### Purpose \nPureQuotaPolicyRule facilitates the management of quota policies, providing structured control and allocation of storage resources within the FlashArray. \n#### Key Concepts \n- **Policy Management:** Offers structured management of quota policy rules, optimizing storage operations and resource allocation. \n- **Integration:** Supports integration with directory objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage quota policy rules within the storage network.", "x-allOf-name": "storage.PureQuotaPolicyRule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureQuotaPolicyRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureQuotaPolicyRule" ], "default": "storage.PureQuotaPolicyRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureQuotaPolicyRule" ], "default": "storage.PureQuotaPolicyRule", "x-enum-as-string": true }, "Destroyed": { "description": "A boolean value, if set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Enforced": { "description": "Enforced of the policy rule.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the quota policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Notifications": { "description": "Notifications of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "Name of the NFS policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuotaLimit": { "description": "Quota limit of the policy rule.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Relationship", "description": "A reference to a storagePureDirectoryPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureQuotaPolicyRule.List": { "title": "List of 'storage.PureQuotaPolicyRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureQuotaPolicyRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureQuotaPolicyRule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureQuotaPolicyRule" }, "nullable": true } } } ] }, "storage.PureRealm.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureRealm' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureRealm' resources.", "x-one-of-name": "storage.PureRealm.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureRealm.Relationship": { "description": "A relationship to the 'storage.PureRealm' resource, or the expanded 'storage.PureRealm' resource, or the 'null' value.", "x-one-of-name": "storage.PureRealm.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureRealm": { "title": "Storage:Pure Realm", "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "x-allOf-name": "storage.PureRealm", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureRealm', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureRealm" ], "default": "storage.PureRealm", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureRealm" ], "default": "storage.PureRealm", "x-enum-as-string": true }, "BandwidthLimit": { "description": "Maximum allowed data throughput for this object.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Created": { "description": "Creation time of the realm.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "IopsLimit": { "description": "Maximum allowed IO operations per second for this object.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the realm as configured on the Pure Storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "QuotaLimit": { "description": "Maximum logical space the object is allowed to consume.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StorageUtilization": { "description": "Storage utilization of realm entity in storage array.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealmUtilization", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Hosts": { "description": "An array of relationships to storagePureHost resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureHost.Relationship" }, "nullable": true, "readOnly": true }, "Pods": { "description": "An array of relationships to storagePurePod resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod.Relationship" }, "nullable": true, "readOnly": true }, "ProtectionGroupSnapshots": { "description": "An array of relationships to storagePureProtectionGroupSnapshot resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot.Relationship" }, "nullable": true, "readOnly": true }, "ProtectionGroups": { "description": "An array of relationships to storagePureProtectionGroup resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship" }, "nullable": true, "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "VolumeSnapshots": { "description": "An array of relationships to storagePureVolumeSnapshot resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot.Relationship" }, "nullable": true, "readOnly": true }, "Volumes": { "description": "An array of relationships to storagePureVolume resources.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "storage.PureRealm.List": { "title": "List of 'storage.PureRealm' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureRealm' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureRealm' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm" }, "nullable": true } } } ] }, "storage.PureRealmUtilization": { "title": "Storage:Pure Realm Utilization", "description": "Storage space utilization metrics for a Pure FlashArray realm entity.", "x-allOf-name": "storage.PureRealmUtilization", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureRealmUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureRealmUtilization" ], "default": "storage.PureRealmUtilization", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureRealmUtilization" ], "default": "storage.PureRealmUtilization", "x-enum-as-string": true }, "DataReduction": { "description": "Ratio of logical data to physical storage due to compression and deduplication only (excludes thin provisioning).", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Footprint": { "description": "The \"as-if only\" physical space consumed by the realm's data, including metadata overhead and system space.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Shared": { "description": "Physical space containing shared data (deduplicated or referenced) across volumes and snapshots in the realm.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Snapshots": { "description": "Physical space attributed exclusively to snapshot data within this realm.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "System": { "description": "Physical space used by system metadata overhead and other internal realm structures.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ThinProvisioning": { "description": "Efficiency ratio of thin provisioning, indicating savings between used provisioned space and virtual usage.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalProvisioned": { "description": "Total logical capacity provisioned to all objects (e.g., volumes) within the realm.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalReduction": { "description": "The combined data efficiency ratio achieved through both data reduction (compression/deduplication) and thin provisioning.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalUsed": { "description": "Total physical space used on the array by the realm, combining unique, shared, and snapshot data (when available).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Unique": { "description": "Unique physical data stored in the realm that is not shared or deduplicated across other objects.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UsedProvisioned": { "description": "Amount of the provisioned space that is currently in use by data written to realm objects (logical size).", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Virtual": { "description": "The total logical data written to the realm, as seen by hosts. Used in calculating reduction approximations.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.PureReplicationBlackout": { "title": "Storage:Pure Replication Blackout", "description": "Range of time at which to suspend replication. System disables replication during this interval.", "x-allOf-name": "storage.PureReplicationBlackout", "allOf": [ { "$ref": "#/components/schemas/storage.BaseReplicationBlackout" } ] }, "storage.PureReplicationSchedule.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureReplicationSchedule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureReplicationSchedule' resources.", "x-one-of-name": "storage.PureReplicationSchedule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureReplicationSchedule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureReplicationSchedule": { "title": "Storage:Pure Replication Schedule", "description": "The PureReplicationSchedule object configures the replication schedule for snapshots within a PureStorage FlashArray, ensuring systematic data synchronization. \n#### Purpose \nPureReplicationSchedule provides structured management of replication schedules, enabling efficient and automated data synchronization strategies within the FlashArray. \n#### Key Concepts \n- **Schedule Management:** Orchestrates the timing and frequency of replication, ensuring consistent data synchronization. \n- **Blackout Periods:** Supports configuration of blackout intervals, optimizing replication operations. \n- **Secure Access:** Employs privilege sets to control and manage replication schedules securely.", "x-allOf-name": "storage.PureReplicationSchedule", "allOf": [ { "$ref": "#/components/schemas/storage.BaseReplicationSchedule" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureReplicationSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureReplicationSchedule" ], "default": "storage.PureReplicationSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureReplicationSchedule" ], "default": "storage.PureReplicationSchedule", "x-enum-as-string": true }, "DailyLimit": { "description": "Total number of snapshots per day to be available on target above and over the specified retention time. PureStorage\nFlashArray maintains all created snapshot until retention period. Daily limit is applied only on the snapshots once retention time is expired.\nIn case of, daily limit is less than the number of snapshot available on source, system select snapshots evenly spaced out throughout the day.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ReplicationBlackoutIntervals": { "type": "array", "items": { "description": "Blackout intervals for replication operation in PureStorage FlashArray. System disables replication during these intervals. Blackout periods only apply to scheduled replications. On-demand replications do not observe the blackout period.", "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureReplicationBlackout", "readOnly": true, "x-omitempty": true }, "nullable": true }, "SnapshotExpiryTime": { "description": "Duration to keep the daily limit snapshots on target array. StorageArray deletes the snapshots permanently from the targets beyond this period.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureReplicationSchedule.List": { "title": "List of 'storage.PureReplicationSchedule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureReplicationSchedule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureReplicationSchedule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureReplicationSchedule" }, "nullable": true } } } ] }, "storage.PureSmbPolicyRule.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureSmbPolicyRule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureSmbPolicyRule' resources.", "x-one-of-name": "storage.PureSmbPolicyRule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureSmbPolicyRule.Relationship": { "description": "A relationship to the 'storage.PureSmbPolicyRule' resource, or the expanded 'storage.PureSmbPolicyRule' resource, or the 'null' value.", "x-one-of-name": "storage.PureSmbPolicyRule.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureSmbPolicyRule": { "title": "Storage:Pure Smb Policy Rule", "description": "The PureSmbPolicyRule object represents SMB policy rules within a PureStorage FlashArray, ensuring organized and efficient storage operations. \n#### Purpose \nPureSmbPolicyRule facilitates the management of SMB policies, providing structured control and allocation of storage resources within the FlashArray.\n#### Key Concepts\n- **Policy Management:** Offers structured management of SMB policy rules, optimizing storage operations and resource allocation. \n- **Integration:** Supports integration with directory objects, enhancing storage management capabilities. \n- **Secure Access:** Utilizes privilege sets to secure and manage SMB policy rules within the storage network.", "x-allOf-name": "storage.PureSmbPolicyRule", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureSmbPolicyRule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureSmbPolicyRule" ], "default": "storage.PureSmbPolicyRule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureSmbPolicyRule" ], "default": "storage.PureSmbPolicyRule", "x-enum-as-string": true }, "AnonymousAccessAllowed": { "description": "Anonymous access allowed of the policy rule.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "ClientName": { "description": "Client of the policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "Destroyed": { "description": "A boolean value, if set to true, lists only destroyed objects that are in the eradication pending state. If set to false, lists only objects that are not destroyed.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the SMB policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "PolicyName": { "description": "Name of the SMB policy rule.", "type": "string", "readOnly": true, "x-omitempty": true }, "SmbEncryptionRequired": { "description": "SMB encryption required of the policy rule.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Policy": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureDirectoryPolicy.Relationship", "description": "A reference to a storagePureDirectoryPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureSmbPolicyRule.List": { "title": "List of 'storage.PureSmbPolicyRule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureSmbPolicyRule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureSmbPolicyRule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSmbPolicyRule" }, "nullable": true } } } ] }, "storage.PureSnapshotSchedule.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureSnapshotSchedule' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureSnapshotSchedule' resources.", "x-one-of-name": "storage.PureSnapshotSchedule.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSnapshotSchedule.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureSnapshotSchedule": { "title": "Storage:Pure Snapshot Schedule", "description": "The PureSnapshotSchedule object configures the snapshot schedule for a PureStorage FlashArray, ensuring systematic data backup processes. \n#### Purpose \nPureSnapshotSchedule provides structured management of snapshot schedules, enabling efficient and automated data protection strategies within the FlashArray. \n#### Key Concepts \n- **Schedule Management:** It orchestrates the timing and frequency of snapshot creation, ensuring consistent data protection. \n- **Retention Configuration:** Offers options for configuring retention periods and daily snapshot limits, optimizing storage utilization. \n- **Secure Access:** Employs privilege sets to control and manage snapshot schedules securely.", "x-allOf-name": "storage.PureSnapshotSchedule", "allOf": [ { "$ref": "#/components/schemas/storage.BaseSnapshotSchedule" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureSnapshotSchedule', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureSnapshotSchedule" ], "default": "storage.PureSnapshotSchedule", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureSnapshotSchedule" ], "default": "storage.PureSnapshotSchedule", "x-enum-as-string": true }, "DailyLimit": { "description": "Total number of snapshots per day to be available on source above and over the specified retention time. PureStorage FlashArray maintains all created snapshot until retention period. Daily limit is applied only on the snapshots once retention time is expired. In case of, daily limit is less than the number of snapshot available on source, system select snapshots evenly spaced out throughout the day.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SnapshotExpiryTime": { "description": "Duration to keep the daily limit snapshots on source array. StorageArray deletes the snapshots permanently from source beyond this period.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureSnapshotSchedule.List": { "title": "List of 'storage.PureSnapshotSchedule' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureSnapshotSchedule' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureSnapshotSchedule' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureSnapshotSchedule" }, "nullable": true } } } ] }, "storage.PureTargetArray.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureTargetArray' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureTargetArray' resources.", "x-one-of-name": "storage.PureTargetArray.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureTargetArray.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureTargetArray": { "title": "Storage:Pure Target Array", "description": "The PureTargetArray object establishes a connection between FlashArrays for replication purposes, enhancing data availability and recovery. \n#### Purpose \nPureTargetArray facilitates replication between storage arrays, ensuring data redundancy and availability through synchronized data operations. \n#### Key Concepts \n- **Replication Management:** It manages connections for data replication, optimizing data availability and recovery processes. \n- **Array Integration:** Establishes links between source and target arrays, ensuring cohesive replication strategies.\n- **Secure Access:** Utilizes privilege sets to secure and manage replication operations within the storage network.", "x-allOf-name": "storage.PureTargetArray", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureTargetArray', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureTargetArray" ], "default": "storage.PureTargetArray", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureTargetArray" ], "default": "storage.PureTargetArray", "x-enum-as-string": true }, "Name": { "description": "Name of the Target FlashArray.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureTargetArray.List": { "title": "List of 'storage.PureTargetArray' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureTargetArray' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureTargetArray' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureTargetArray" }, "nullable": true } } } ] }, "storage.PureVolume.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureVolume' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureVolume' resources.", "x-one-of-name": "storage.PureVolume.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureVolume.Relationship": { "description": "A relationship to the 'storage.PureVolume' resource, or the expanded 'storage.PureVolume' resource, or the 'null' value.", "x-one-of-name": "storage.PureVolume.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureVolume": { "title": "Storage:Pure Volume", "description": "A volume entity in PureStorage FlashArray.", "x-allOf-name": "storage.PureVolume", "allOf": [ { "$ref": "#/components/schemas/storage.BaseVolume" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureVolume', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureVolume" ], "default": "storage.PureVolume", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureVolume" ], "default": "storage.PureVolume", "x-enum-as-string": true }, "Created": { "description": "Creation time of the volume.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "NxVmDiskId": { "description": "Nutanix disk UUID (extId) from owner_disk_id tag value.", "type": "string", "readOnly": true, "x-omitempty": true }, "NxVmId": { "description": "Nutanix VM UUID (extId) from owner_id tag value.", "type": "string", "readOnly": true, "x-omitempty": true }, "PodName": { "description": "A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "Serial number of the volume.", "type": "string", "readOnly": true, "x-omitempty": true }, "Source": { "description": "Source from which the volume is created. Applicable only if the volume is cloned from other volume or snapshot.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pod": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PurePod.Relationship", "description": "A reference to a storagePurePod resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroup": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroup.Relationship", "description": "A reference to a storagePureProtectionGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureVolume.List": { "title": "List of 'storage.PureVolume' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureVolume' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureVolume' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume" }, "nullable": true } } } ] }, "storage.PureVolumeGroup.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureVolumeGroup' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureVolumeGroup' resources.", "x-one-of-name": "storage.PureVolumeGroup.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeGroup.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureVolumeGroup": { "title": "Storage:Pure Volume Group", "description": "A volume group is a collection of volumes that can be managed as a single entity for simplified administration and consistent policy application.", "x-allOf-name": "storage.PureVolumeGroup", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureVolumeGroup', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureVolumeGroup" ], "default": "storage.PureVolumeGroup", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureVolumeGroup" ], "default": "storage.PureVolumeGroup", "x-enum-as-string": true }, "Name": { "description": "Name of the Volume Group.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureVolumeGroup.List": { "title": "List of 'storage.PureVolumeGroup' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureVolumeGroup' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureVolumeGroup' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeGroup" }, "nullable": true } } } ] }, "storage.PureVolumeSnapshot.Response": { "description": "The response body of a HTTP GET request for the 'storage.PureVolumeSnapshot' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.PureVolumeSnapshot' resources.", "x-one-of-name": "storage.PureVolumeSnapshot.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.PureVolumeSnapshot.Relationship": { "description": "A relationship to the 'storage.PureVolumeSnapshot' resource, or the expanded 'storage.PureVolumeSnapshot' resource, or the 'null' value.", "x-one-of-name": "storage.PureVolumeSnapshot.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.PureVolumeSnapshot": { "title": "Storage:Pure Volume Snapshot", "description": "The PureVolumeSnapshot object represents a snapshot of a volume within a PureStorage FlashArray, created either on-demand or via scheduler. \n#### Purpose \nThe PureVolumeSnapshot provides a mechanism for data backup and recovery, enabling efficient snapshot creation and management within the storage array. \n#### Key Concepts \n- **Snapshot Management:** Facilitates the creation and management of immutable snapshots, ensuring data protection and recovery. \n- **Scheduler Integration:** Supports both on-demand and scheduled snapshot creation, offering flexible data management options. \n- **Secure Access:** Utilizes privilege sets to ensure secure snapshot management within the FlashArray.", "x-allOf-name": "storage.PureVolumeSnapshot", "allOf": [ { "$ref": "#/components/schemas/storage.BaseSnapshot" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.PureVolumeSnapshot', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.PureVolumeSnapshot" ], "default": "storage.PureVolumeSnapshot", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.PureVolumeSnapshot" ], "default": "storage.PureVolumeSnapshot", "x-enum-as-string": true }, "Pod": { "description": "A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays.", "type": "string", "readOnly": true, "x-omitempty": true }, "RealmName": { "description": "A realm is the core multi-tenancy component on a Pure Flash Array, providing a self-contained, virtual storage environment with dedicated policies and quotas for secure data isolation and predictable performance.", "type": "string", "readOnly": true, "x-omitempty": true }, "Serial": { "description": "Unique serial number of the snapshot allocated by the storage array.", "type": "string", "readOnly": true, "x-omitempty": true }, "SnapshotSize": { "description": "The size of the snapshot created.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "TotalProvisioned": { "description": "The overall size of the snapshot allocated by the storage array.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "UsedProvisioned": { "description": "The used size of the snapshot allocated by the storage array.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VolumeGroup": { "description": "Volume groups organize volumes into logical groupings. If virtual volumes are configured, each volume group on the FlashArray array represents its associated virtual machine, and inside each of those volumes groups are the FlashArray volumes that are assigned to the virtual machine.", "type": "string", "readOnly": true, "x-omitempty": true }, "Array": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureArray.Relationship", "description": "A reference to a storagePureArray resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ProtectionGroupSnapshot": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureProtectionGroupSnapshot.Relationship", "description": "A reference to a storagePureProtectionGroupSnapshot resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Realm": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureRealm.Relationship", "description": "A reference to a storagePureRealm resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Volume": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolume.Relationship", "description": "A reference to a storagePureVolume resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.PureVolumeSnapshot.List": { "title": "List of 'storage.PureVolumeSnapshot' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.PureVolumeSnapshot' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.PureVolumeSnapshot' resources matching the request.", "type": "array", "items": { "$ref": "intersight-storage-v3-1.0.11-20260807064027971.json#/components/schemas/storage.PureVolumeSnapshot" }, "nullable": true } } } ] }, "storage.PureVolumeUtilization": { "title": "Storage:Pure Volume Utilization", "description": "The PureVolume object represents a volume entity within a PureStorage FlashArray, serving as a fundamental unit for managing storage capacity and functionality. \n#### Purpose \nPureVolume is used to organize and control the storage network addresses of client computers, ensuring efficient and secure data storage operations. It plays a critical role in managing storage resources by enabling users to read and interact with data stored on the FlashArray.\n#### Key Concepts \n- **Storage Management:** PureVolume provides a mechanism for organizing storage, allowing for streamlined operations and effective resource allocation. \n- **Access Control:** It supports various privilege sets, ensuring that only authorized users can perform actions on the storage array. \n- **Integration:** PureVolume is designed to work seamlessly with other objects within the storage network, such as hosts and host groups, facilitating integrated storage solutions.", "x-allOf-name": "storage.PureVolumeUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.StorageUtilization" } ] }, "storage.R0Drive": { "title": "MRAID/RAID Single Drive RAID0 Configuration", "description": "This models a Single Drive RAID Configuration for creation of on RAID0 virtual drive per physical drive and occupying the full disk space on the same.", "x-allOf-name": "storage.R0Drive", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.R0Drive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.R0Drive" ], "default": "storage.R0Drive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.R0Drive" ], "default": "storage.R0Drive", "x-enum-as-string": true }, "DriveSlots": { "description": "The set of drive slots where RAID0 virtual drives must be created.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "DriveSlotsList": { "description": "The list of drive slots where RAID0 virtual drives must be created (comma separated).", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "readOnly": true, "x-omitempty": true }, "Enable": { "description": "If enabled, this will create a RAID0 virtual drive per disk and encompassing the whole disk.", "type": "boolean", "default": false, "x-omitempty": true }, "VirtualDrivePolicy": { "description": "This defines the characteristics of a specific virtual drive.", "$ref": "#/components/schemas/storage.VirtualDrivePolicy", "x-omitempty": true } } } ] }, "storage.RemoteKeySetting": { "title": "Remote Key Management", "description": "Models the remote key configuration required for the drive security.", "x-allOf-name": "storage.RemoteKeySetting", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.RemoteKeySetting', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.RemoteKeySetting" ], "default": "storage.RemoteKeySetting", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.RemoteKeySetting" ], "default": "storage.RemoteKeySetting", "x-enum-as-string": true }, "AuthCredentials": { "description": "The authentication details of the KMIP server. It is required to login to the KMIP server.", "$ref": "#/components/schemas/storage.KmipAuthCredentials", "x-omitempty": true }, "ExistingKey": { "description": "Current Security Key Passphrase which is already configured on the server. From the security context, the passphrase should be at least 8 characters long and should include at least one uppercase letter, one lowercase letter, one number, and one special character.", "type": "string", "maxLength": 32, "writeOnly": true, "x-omitempty": true }, "IsExistingKeySet": { "description": "Indicates whether the value of the 'existingKey' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "PrimaryServer": { "description": "Configuration of the primary KMIP server.", "$ref": "#/components/schemas/storage.KmipServer", "x-omitempty": true }, "SecondaryServer": { "description": "Configuration of the secondary KMIP server.", "$ref": "#/components/schemas/storage.KmipServer", "x-omitempty": true }, "ServerCertificate": { "description": "The certificate/ public key of the KMIP server. It is required for initiating secure communication with the server.", "type": "string", "x-omitempty": true } } } ] }, "storage.SasExpander.Response": { "description": "The response body of a HTTP GET request for the 'storage.SasExpander' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.SasExpander' resources.", "x-one-of-name": "storage.SasExpander.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.SasExpander.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.SasExpander.Relationship": { "description": "A relationship to the 'storage.SasExpander' resource, or the expanded 'storage.SasExpander' resource, or the 'null' value.", "x-one-of-name": "storage.SasExpander.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.SasExpander" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.SasExpander": { "title": "Storage:Sas Expander", "description": "SAS Expander present in a server.", "x-allOf-name": "storage.SasExpander", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.SasExpander', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.SasExpander" ], "default": "storage.SasExpander", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.SasExpander" ], "default": "storage.SasExpander", "x-enum-as-string": true }, "ExpanderId": { "description": "Unique Identifier of the storage expander.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the installed storage expander.", "type": "string", "x-omitempty": true }, "OperState": { "description": "The operational state of the storage expander.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "The operability status of the storage expander.", "type": "string", "readOnly": true, "x-omitempty": true }, "SasAddress": { "description": "The SAS address of the SAS expander.", "type": "string", "readOnly": true, "x-omitempty": true }, "ComputeRackUnit": { "$ref": "#/components/schemas/compute.RackUnit.Relationship", "description": "A reference to a computeRackUnit resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Controller": { "$ref": "#/components/schemas/management.Controller.Relationship", "description": "A reference to a managementController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.SasExpander.List": { "title": "List of 'storage.SasExpander' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.SasExpander' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.SasExpander' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.SasExpander" }, "nullable": true } } } ] }, "storage.SasPort.Response": { "description": "The response body of a HTTP GET request for the 'storage.SasPort' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.SasPort' resources.", "x-one-of-name": "storage.SasPort.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.SasPort.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.SasPort.Relationship": { "description": "A relationship to the 'storage.SasPort' resource, or the expanded 'storage.SasPort' resource, or the 'null' value.", "x-one-of-name": "storage.SasPort.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.SasPort" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.SasPort": { "title": "Storage:Sas Port", "description": "Sas Port details of the SAS endpoint.", "x-allOf-name": "storage.SasPort", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.SasPort', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.SasPort" ], "default": "storage.SasPort", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.SasPort" ], "default": "storage.SasPort", "x-enum-as-string": true }, "Address": { "description": "The SAS Address assigned to storage port.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskId": { "description": "The unique disk identifier.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EndPointId": { "description": "The end-point Id assigned to storage port.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "LinkDescription": { "description": "The description for the link.", "type": "string", "readOnly": true, "x-omitempty": true }, "LinkSpeed": { "description": "The link speed negotiated for communication.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StoragePhysicalDisk": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship", "description": "A reference to a storagePhysicalDisk resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.SasPort.List": { "title": "List of 'storage.SasPort' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.SasPort' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.SasPort' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.SasPort" }, "nullable": true } } } ] }, "storage.Space": { "title": "Storage:Space", "description": "Some attributes for the free space and the LDEV defined in the specified external parity group.", "x-allOf-name": "storage.Space", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Space', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Space" ], "default": "storage.Space", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Space" ], "default": "storage.Space", "x-enum-as-string": true }, "LbaLocation": { "description": "Starting location of the LBA of the partition in the external parity group (in a multiple of 512 bytes).", "type": "string", "readOnly": true, "x-omitempty": true }, "LbaSize": { "description": "Size of the partition in the external parity group (in a multiple of 512 bytes).", "type": "string", "readOnly": true, "x-omitempty": true }, "LdevId": { "description": "LDEV number, property is output only if LDEV has been implemented.", "type": "string", "readOnly": true, "x-omitempty": true }, "PartitionNumber": { "description": "Number of a partition created as a result of partitioning of an external parity group.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Status": { "description": "Status about LDEV for partition.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.Span.Response": { "description": "The response body of a HTTP GET request for the 'storage.Span' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.Span' resources.", "x-one-of-name": "storage.Span.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.Span.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.Span.Relationship": { "description": "A relationship to the 'storage.Span' resource, or the expanded 'storage.Span' resource, or the 'null' value.", "x-one-of-name": "storage.Span.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.Span" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.Span": { "title": "Storage:Span", "description": "Group of disks to configure virtual drive.", "x-allOf-name": "storage.Span", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.Span', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.Span" ], "default": "storage.Span", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.Span" ], "default": "storage.Span", "x-enum-as-string": true }, "Slots": { "type": "array", "items": { "description": "Drive Slots belonging to this span.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "SpanId": { "description": "Unique identifier value of this span.", "type": "integer", "format": "int64", "x-omitempty": true }, "DiskGroup": { "$ref": "#/components/schemas/storage.DiskGroup.Relationship", "description": "A reference to a storageDiskGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PhysicalDisks": { "description": "An array of relationships to storagePhysicalDisk resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDisk.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.Span.List": { "title": "List of 'storage.Span' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.Span' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.Span' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.Span" }, "nullable": true } } } ] }, "storage.SpanDrives": { "title": "Storage:Span Drives", "description": "This models a single span group of disks in a RAID group.", "x-allOf-name": "storage.SpanDrives", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.SpanDrives', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.SpanDrives" ], "default": "storage.SpanDrives", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.SpanDrives" ], "default": "storage.SpanDrives", "x-enum-as-string": true }, "Slots": { "description": "Collection of local disks that are part of this span group. Allowed value is a comma or hyphen separated number range. The minimum number of disks needed in a span group varies based on RAID level. RAID0 requires at least one disk, RAID1 and RAID10 requires at least 2 and in multiples of 2, RAID5 RAID50 RAID6 and RAID60 require at least 3 disks in a span group.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-createOnly": true, "x-omitempty": true } } } ] }, "storage.StorageContainerHostMountStatus": { "title": "Storage:Storage Container Host Mount Status", "description": "Storage container host mount and accessibility status. Applicable only for NFS type.", "x-allOf-name": "storage.StorageContainerHostMountStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.StorageContainerHostMountStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.StorageContainerHostMountStatus" ], "default": "storage.StorageContainerHostMountStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.StorageContainerHostMountStatus" ], "default": "storage.StorageContainerHostMountStatus", "x-enum-as-string": true }, "Accessibility": { "description": "Host specific storage container accessibility status.\n* `NOT_APPLICABLE` - The HyperFlex storage container accessibility on host is not applicable.\n* `ACCESSIBLE` - The HyperFlex storage container is accessible on the host.\n* `NOT_ACCESSIBLE` - The HyperFlex storage container is not accessible on the host.\n* `PARTIALLY_ACCESSIBLE` - The HyperFlex storage container is partially accessible on the host.\n* `READONLY` - The HyperFlex storage container accessibility is readonly on the host.\n* `HOST_NOT_REACHABLE` - The storage container is not accessible via this host because it is not accessible.\n* `UNKNOWN` - The storage container accessibility via this host is unknown.", "type": "string", "enum": [ "NOT_APPLICABLE", "ACCESSIBLE", "NOT_ACCESSIBLE", "PARTIALLY_ACCESSIBLE", "READONLY", "HOST_NOT_REACHABLE", "UNKNOWN" ], "default": "NOT_APPLICABLE", "readOnly": true, "x-omitempty": true }, "HostName": { "description": "The name of the host corresponding to the mount and accessibility status of the storage container.", "type": "string", "readOnly": true, "x-omitempty": true }, "Mounted": { "description": "Host specific storage container mount status.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "Reason": { "description": "Host specific storage container mount status reason.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "storage.StorageContainerUtilization": { "title": "Storage:Storage Container Utilization", "description": "Storage space utilization of HyperFlex Storage Container entity.", "x-allOf-name": "storage.StorageContainerUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" } ] }, "storage.StoragePolicy.Response": { "description": "The response body of a HTTP GET request for the 'storage.StoragePolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.StoragePolicy' resources.", "x-one-of-name": "storage.StoragePolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.StoragePolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.StoragePolicy.Relationship": { "description": "A relationship to the 'storage.StoragePolicy' resource, or the expanded 'storage.StoragePolicy' resource, or the 'null' value.", "x-one-of-name": "storage.StoragePolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.StoragePolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.StoragePolicy": { "title": "Storage", "description": "The StoragePolicy object models reusable storage configurations applicable to multiple servers. It enables RAID group creation and offers flexibility in drive state management.\n#### Purpose\nThe StoragePolicy object provides a unified framework for configuring and managing storage solutions. It enables the creation of RAID groups using predefined disk group policies and offers flexible drive state management, allowing unused disks to be moved to JBOD or Unconfigured Good states while supporting hybrid slot configurations for transitions between direct and controller modes.\n#### Key Concepts\n- **Drive Security:** Enhances data protection through remote or manual key settings for drive encryption.\n- **Global Hot Spares:** Configures disks as hot spares across RAID groups to improve storage reliability.\n- **Nvme Drive Management:** Includes settings for NVMe drive attachment modes, supporting both direct and controller attached configurations.", "x-allOf-name": "storage.StoragePolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.StoragePolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.StoragePolicy" ], "default": "storage.StoragePolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.StoragePolicy" ], "default": "storage.StoragePolicy", "x-enum-as-string": true }, "ControllerAttachedNvmeSlots": { "description": "Only U.3 NVMe drives need to be specified, entered slots will be moved to controller attached mode. Allowed slots are 1-9, 21-24, 101-104. Allowed value is a comma or hyphen separated number ranges.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "DefaultDriveMode": { "description": "All unconfigured drives will move to the selected state on deployment. Newly inserted drives will move to the selected state. Select Unconfigured Good option to retain the existing configuration. Select JBOD to move the unconfigured drives to JBOD state. Select RAID0 to create a RAID0 virtual drive on each of the unconfigured drives. If JBOD is selected, unconfigured drives will move to JBOD state on host reboot. This setting is applicable only to selected set of controllers on FI attached servers.\n* `UnconfiguredGood` - Newly inserted drives or on reboot, drives will remain the same state.\n* `Jbod` - Newly inserted drives or on reboot, drives will automatically move to JBOD state if drive state was UnconfiguredGood.\n* `RAID0` - Newly inserted drives or on reboot, virtual drives will be created, respective drives will move to Online state.", "type": "string", "enum": [ "UnconfiguredGood", "Jbod", "RAID0" ], "default": "UnconfiguredGood", "x-omitempty": true }, "DirectAttachedNvmeSlots": { "description": "Only U.3 NVMe drives need to be specified, entered slots will be moved to Direct attached mode. Allowed slots are 1-9, 21-24, 101-104. Allowed value is a comma or hyphen separated number ranges.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "GlobalHotSpares": { "description": "A collection of disks that is to be used as hot spares, globally, for all the RAID groups. Allowed value is a number range separated by a comma or a hyphen.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "M2VirtualDrive": { "description": "Virtual Drive configuration for M.2 RAID controller.", "$ref": "#/components/schemas/storage.M2VirtualDriveConfig", "x-omitempty": true }, "Raid0Drive": { "description": "The list of disks where RAID0 virtual drives must be created on each individual drive.", "$ref": "#/components/schemas/storage.R0Drive", "x-omitempty": true }, "RaidAttachedNvmeSlots": { "description": "Only U.3 NVMe drives need to be specified, entered slots will be moved to RAID attached mode. Allowed slots are 1-4, 101-104. Allowed value is a comma or hyphen separated number ranges. Deprecated in favor of controllerAttachedNvmeSlots.", "deprecated": true, "x-sunset": "2027-03-01", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "SecureJbods": { "description": "JBOD drives specified in this slot range will be encrypted. Allowed values are 'ALL', or a comma or hyphen separated number range. Sample format is ALL or 1, 3 or 4-6, 8. Setting the value to 'ALL' will encrypt all the unused UnconfigureGood/JBOD disks.", "type": "string", "pattern": "^$|^((((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*)|(a|A)(l|L)(l|L))$", "x-omitempty": true }, "UnusedDisksState": { "description": "State to which drives, not used in this policy, are to be moved. NoChange will not change the drive state. No Change must be selected if Default Drive State is set to JBOD or RAID0.\n* `NoChange` - Drive state will not be modified by Storage Policy.\n* `UnconfiguredGood` - Unconfigured good state -ready to be added in a RAID group.\n* `Jbod` - JBOD state where the disks start showing up to Host OS.", "type": "string", "enum": [ "NoChange", "UnconfiguredGood", "Jbod" ], "default": "NoChange", "x-omitempty": true }, "UseJbodForVdCreation": { "description": "Disks in JBOD State are used to create virtual drives. This setting must be disabled if Default Drive State is set to JBOD.", "type": "boolean", "x-omitempty": true }, "DriveGroup": { "description": "An array of relationships to storageDriveGroup resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.DriveGroup.Relationship" }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "storage.StoragePolicy.List": { "title": "List of 'storage.StoragePolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.StoragePolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.StoragePolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.StoragePolicy" }, "nullable": true } } } ] }, "storage.StorageUtilization": { "title": "Storage:Storage Utilization", "description": "Storage space utilized by Pure storage entity.", "x-allOf-name": "storage.StorageUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.StorageUtilization', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureHostUtilization", "storage.PureVolumeUtilization" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "storage.PureHostUtilization", "storage.PureVolumeUtilization" ], "x-enum-as-string": true }, "DataReduction": { "description": "Ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5.0 means that for every 5 MB the host writes to the array, 1 MB is stored on the array's flash modules.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Snapshot": { "description": "Physical space occupied by the snapshots, represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "ThinProvisioned": { "description": "Percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "TotalReduction": { "description": "Ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10.0 means that for every 10 MB of provisioned space, 1 MB is stored on the array's flash modules.", "type": "number", "format": "float", "readOnly": true, "x-omitempty": true }, "Volume": { "description": "Physical space occupied by volume data, excluding shared, array metadata and snapshots. Size id represented in bytes.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "storage.VdMemberEp.Response": { "description": "The response body of a HTTP GET request for the 'storage.VdMemberEp' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.VdMemberEp' resources.", "x-one-of-name": "storage.VdMemberEp.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.VdMemberEp.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.VdMemberEp.Relationship": { "description": "A relationship to the 'storage.VdMemberEp' resource, or the expanded 'storage.VdMemberEp' resource, or the 'null' value.", "x-one-of-name": "storage.VdMemberEp.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.VdMemberEp" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.VdMemberEp": { "title": "Storage:Vd Member Ep", "description": "Reference to LocalDisk to build up a VirtualDrive.", "x-allOf-name": "storage.VdMemberEp", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VdMemberEp', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VdMemberEp" ], "default": "storage.VdMemberEp", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VdMemberEp" ], "default": "storage.VdMemberEp", "x-enum-as-string": true }, "OperQualifierReason": { "description": "For certain states, indicates the reason why the operState is in that state.", "type": "string", "readOnly": true, "x-omitempty": true }, "Presence": { "description": "The presence state of the local disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "Role": { "description": "Role of the disk normal or hot-spare, used by virtual-drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "SpanId": { "description": "The span id number of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "VdMemberEpId": { "description": "The local disk slot number as id.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageVirtualDrive": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship", "description": "A reference to a storageVirtualDrive resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.VdMemberEp.List": { "title": "List of 'storage.VdMemberEp' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.VdMemberEp' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.VdMemberEp' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VdMemberEp" }, "nullable": true } } } ] }, "storage.VirtualDrive.Response": { "description": "The response body of a HTTP GET request for the 'storage.VirtualDrive' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.VirtualDrive' resources.", "x-one-of-name": "storage.VirtualDrive.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.VirtualDrive.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.VirtualDrive.Relationship": { "description": "A relationship to the 'storage.VirtualDrive' resource, or the expanded 'storage.VirtualDrive' resource, or the 'null' value.", "x-one-of-name": "storage.VirtualDrive.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.VirtualDrive" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.VirtualDrive": { "title": "Storage:Virtual Drive", "description": "A Virtual Disk Drive or Logical Unit Number.", "x-allOf-name": "storage.VirtualDrive", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDrive', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDrive" ], "default": "storage.VirtualDrive", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDrive" ], "default": "storage.VirtualDrive", "x-enum-as-string": true }, "AccessPolicy": { "description": "The access policy of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ActualWriteCachePolicy": { "description": "The current write cache policy of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "AvailableSize": { "description": "Available storage capacity of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "BlockSize": { "description": "Block size of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Bootable": { "description": "The virtual drive bootable state.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfigState": { "description": "The configuration state of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConfiguredWriteCachePolicy": { "description": "The requested write cache policy of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ConnectionProtocol": { "description": "The connection protocol of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriveCache": { "description": "The state of the drive cache of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriveSecurity": { "description": "The driveSecurity state of the Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DriveState": { "description": "The state of the Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "IoPolicy": { "description": "The Input/Output Policy defined on the Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "NumBlocks": { "description": "Number of Blocks on the Physical Disk.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperReason": { "type": "array", "items": { "description": "The details of one or more health issues of the Virtual Drive.\n* `Unknown` - The health state current threshold limit is not known.\n* `OK` - The health state is good and normal.\n* `Offline` - The operation state of the iocard is offline.\n* `Missing` - The presence state of iocard is missing.\n* `HealthWarning` - The health state reached the warning limit.\n* `HealthCritical` - The health state reached the critical limit.\n* `TemperatureWarning` - The temperature related health state reached the warning limit.\n* `TemperatureCritical` - The temperature related health state reached the critical limit.\n* `InputVoltageWarning` - The input voltage related health state reached the warning limit.\n* `InputVoltageCritical` - The input voltage related health state reached the critical limit.\n* `OutputVoltageWarning` - The output voltage related health state reached the warning limit.\n* `OutputVoltageCritical` - The output voltage related health state reached the critical limit.\n* `OutputCurrentWarning` - The current related health state reached the warning limit.\n* `OutputCurrentCritical` - The current related health state reached the critical limit.\n* `SpeedWarning` - The speed related health state reached the warning limit.\n* `SpeedCritical` - The speed related health state reached critical limit.\n* `FanMissingWarning` - This health state states that one fan is missing for the chassis.\n* `FansMissingCritical` - This health state states that multiple fans are missing for the chassis.\n* `IocardPostWarning` - The health state for iocard post has reached the state of warning.\n* `AsicPostWarning` - The health state for ASIC post has reached the state of warning.\n* `TPMCritical` - The health state for TPM reached the critical state.\n* `FruStateCritical` - The health state for fru reached the critical state.\n* `InbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `InbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Inband and Out-of-Band (Management) interfaces.\n* `OutbandIpv4ConflictCritical` - IPv4 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `OutbandIpv6ConflictCritical` - IPv6 address conflict is detected between the Out-of-Band (Management) and Inband interfaces.\n* `FruStateWarning` - The health state for fru reached the state of warning.\n* `AlternateImageWarning` - The health state for iocard alternate image reached discrete warning state.\n* `SelectedImageWarning` - The health state for iocard selected image reached discrete warning state.\n* `SwitchHealthCritical` - The health state for Switch is critical.\n* `LowMemoryCritical` - The health state for iocard low memory state reached critical limit.\n* `LowMemoryWarning` - The health state for iocard low memory state reached warning limit.\n* `PowerCritical` - The health state for power supply reached discrete critical state.\n* `PowerWarning` - The health state for power supply reached discrete warning state.\n* `ThermalSafeModeCritical` - The health state for blade server thermal safe mode reached.\n* `PsuRedundancyLostCritical` - The health state for chassis psu redundancy lost reached.\n* `InputPowerWarning` - The health state for chassis input power reached the warning limit.\n* `InputPowerCritical` - The health state for chassis input power reached critical limit.\n* `OutputPowerWarning` - The health state for chassis output power reached warning limit.\n* `OutputPowerCritical` - The health state for chassis output power reached critical limit.\n* `FanGeneralCritical` - The health state for fan general error reached critical limit.\n* `PowerSupplyGeneralCritical` - The health state for power supply general error reached critical limit.\n* `PowerSupplyInputWarning` - The health state for chassis power supply input reached warning limit.\n* `PowerSupplyOutputCritical` - The health state for chassis power supply output reached critical limit.\n* `PowerSupplyInputLostWarning` - The health state for chassis power supply lost input.\n* `PowerSupplyUnresponsiveCritical` - The health state for chassis power supply is unresponsive.\n* `PowerSupplyPredictiveFailure` - The health state monitor predicts power supply failure.\n* `PowerSupplyDetectionFailure` - The health state monitor detects power supply failure.\n* `PsuFastOverCurrentWarning` - Chassis power supply fast over current (FOC) condition detected.\n* `FanUnresponsiveCritical` - The health state for chassis fan unit is unresponsive.\n* `MemoryUncorrectableError` - The memory unit has encountered an uncorrectable ECC error.\n* `MemoryTemperatureWarning` - The memory unit has encountered a warning temperature condition.\n* `MemoryTemperatureCritical` - The memory unit has encountered a critical temperature condition.\n* `MemoryBankError` - The memory unit has encountered a bank VLS error.\n* `MemoryRankError` - The memory unit has encountered a rank VLS error.\n* `MemoryPopError` - The memory unit has been populated incorrectly.\n* `MemoryRasError` - The memory unit has encountered a RAS error.\n* `MemoryMismatchError` - The memory unit has encountered a mismatch error.\n* `MemorySpdError` - The memory unit has encountered a SPD error.\n* `MemoryBistError` - The memory unit has encountered a BIST error.\n* `MemoryTypeError` - The memory unit installed is of an invalid type.\n* `MemoryDisabledUnknownError` - The installed memory unit has been disabled but the reason is unknown.\n* `MotherBoardPowerCritical` - The motherboard has encountered a critical power condition.\n* `MotherBoardTemperatureWarning` - The motherboard has encountered a warning temperature condition.\n* `MotherBoardTemperatureCritical` - The motherboard has encountered a critical temperature condition.\n* `MotherBoardVoltageWarning` - The motherboard has encountered a warning voltage condition.\n* `MotherBoardVoltageCritical` - The motherboard has encountered a critical voltage condition.\n* `MotherBoardPCHFuseFail` - The motherboard PCH Security Fuse Verification has failed.\n* `MotherBoardCPLDImageVerificationFail` - The motherboard CPLD image verification has failed.\n* `LowLevelComponentFailure` - One or more low level components have stopped working on the motherboard.\n* `ProcessorCatErr` - The processor has encountered a CATERR error.\n* `ProcessorThermTrip` - The processor has encountered a THERMTRIP error.\n* `ComponentNotOperational` - Given component is not running or operationally down.\n* `OperationalThroughFailover` - Given component is operational using the failover component.\n* `ComponentNotReachable` - Given component is not reachable or connection to the component from a device is lost.\n* `ProcessorTemperatureWarning` - The processor has encountered a warning temperature condition.\n* `ProcessorTemperatureCritical` - The processor has encountered a critical temperature condition.\n* `ProcessorPowerCritical` - The processor has encountered a critical power condition.\n* `ProcessorInternalError` - The processor has encountered an Internal Error.\n* `ProcessorBISTFailure` - The processor has encountered a BIST failure Error.\n* `ProcessorHangInPOSTFailure` - The processor has encountered a hang in POST failure error.\n* `ProcessorInitFailure` - The processor has encountered an Init failure error.\n* `ProcessorConfigurationFailure` - The processor has encountered a Configuration failure error.\n* `ProcessorSMBIOSUncorrectableCPUComplexError` - The processor has encountered a SMBIOS Uncorrectable CPU Complex error.\n* `PCIeNodeRiserMismatch` - PCIe node Riser mismatch.\n* `PCIeNodeRiser1Missing` - PCIe node Riser 1 missing.\n* `PCIeNodeRiser2PresentCPU2Absent` - PCIe node Riser 2 present, but CPU2 absent.\n* `PCIeNodePCIeLinkConfigIssue` - PCIe node PCIe link or port config issue.\n* `PCIeNodeRiser1PowerFault` - PCIe node Riser 1 power fault detected.\n* `PCIeNodeRiser2PowerFault` - PCIe node Riser 2 power fault detected.\n* `PCIeNodePowerFault` - PCIe node power fault detected.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser1` - PCIe node has an unsupported PCIe card present on Riser 1.\n* `PCIeNodeUnsupportedPCIeCardPresentOnRiser2` - PCIe node has an unsupported PCIe card present on Riser 2.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser1` - PCIe node has an unknwon PCIe card present on Riser 1.\n* `PCIeNodeUnknownPCIeCardPresentOnRiser2` - PCIe node has an unknown PCIe card present on Riser 2.\n* `PCIeNodePresentXFM1Absent` - PCIe node detected with missing XFM1.\n* `InvalidConnections` - One or more connections to FI is not valid.\n* `FexReplaced` - Fex connected to FI is replaced.\n* `ThermalSafeModeCriticalServerSlot1` - The health state at the time of temperature sensor read failure for the server in slot 1.\n* `ThermalSafeModeCriticalServerSlot2` - The health state at the time of temperature sensor read failure for the server in slot 2.\n* `ThermalSafeModeCriticalServerSlot3` - The health state at the time of temperature sensor read failure for the server in slot 3.\n* `ThermalSafeModeCriticalServerSlot4` - The health state at the time of temperature sensor read failure for the server in slot 4.\n* `ThermalSafeModeCriticalServerSlot5` - The health state at the time of temperature sensor read failure for the server in slot 5.\n* `ThermalSafeModeCriticalServerSlot6` - The health state at the time of temperature sensor read failure for the server in slot 6.\n* `ThermalSafeModeCriticalServerSlot7` - The health state at the time of temperature sensor read failure for the server in slot 7.\n* `ThermalSafeModeCriticalServerSlot8` - The health state at the time of temperature sensor read failure for the server in slot 8.\n* `ThermalSafeModeCriticalXFM1` - The health state at the time of temperature sensor read failure for the XFM in slot 1.\n* `ThermalSafeModeCriticalXFM2` - The health state at the time of temperature sensor read failure for the XFM in slot 2.\n* `ThermalSafeModeCriticalIFM1` - The health state at the time of temperature sensor read failure for the IFM in slot 1.\n* `ThermalSafeModeCriticalIFM2` - The health state at the time of temperature sensor read failure for the IFM in slot 2.\n* `ChassisAvailablePowerInsufficient` - Chassis available power is insufficient.\n* `ChassisPowerBudgetInsufficient` - Chassis power allocation is insufficient.\n* `ChassisPowerInsufficient` - Chassis power is insufficient.\n* `PowerBackupFailedCritical` - NVMe controller power backup has critical condition.\n* `PowerBackupFailedWarning` - NVMe controller power backup has warning condition.\n* `SpareCapacityWornOutCritical` - NVMe controller spare capacity has critical wornout condition.\n* `SpareCapacityWornOutWarning` - NVMe controller spare capacity has warning wornout condition.\n* `MediaInReadOnlyCritical` - NVMe controller media is operating in read-only mode.\n* `MediaInReadOnlyWarning` - NVMe controller media is operating in read-only mode.\n* `OverallSubsystemDegradedCritical` - NVMe controller storage subsytem has critical degraded condition.\n* `OverallSubsystemDegradedWarning` - NVMe controller storage subsytem has warning degraded condition.\n* `XFMUnsupportedCardInPCIeSlot1` - Unsupported card detected in X-Fabric module PCIe slot 1.\n* `XFMUnsupportedCardInPCIeSlot2` - Unsupported card detected in X-Fabric module PCIe slot 2.\n* `XFMUnknownCardInPCIeSlot1` - Unknown card detected in X-Fabric module PCIe slot 1.\n* `XFMUnknownCardInPCIeSlot2` - Unknown card detected in X-Fabric module PCIe slot 2.\n* `XFMPCIeSwitch1PowerFault` - Power fault detected on X-Fabric module PCIe switch 1.\n* `XFMPCIeSwitch2PowerFault` - Power fault detected on X-Fabric module PCIe switch 2.\n* `XFMPCIeSwitch1CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 1.\n* `XFMPCIeSwitch2CommunicationFailure` - X-Fabric module management controller is unable to communicate with PCIe switch 2.\n* `XFMComputeSlot1CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 1.\n* `XFMComputeSlot2CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 2.\n* `XFMComputeSlot3CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 3.\n* `XFMComputeSlot4CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 4.\n* `XFMComputeSlot5CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 5.\n* `XFMComputeSlot6CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 6.\n* `XFMComputeSlot7CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 7.\n* `XFMComputeSlot8CommunicationFailure` - X-Fabric module management controller is unable to communicate with the device in chassis slot 8.\n* `PCIeNodeHotswapController1Fault` - Hotswap Controller 1 on the PCIe node has a critical power fault.\n* `PCIeNodeHotswapController2Fault` - Hotswap Controller 2 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick1Fault` - DC Brick 1 on the PCIe node has a critical power fault.\n* `PCIeNodeDcBrick2Fault` - DC Brick 2 on the PCIe node has a critical power fault.\n* `PCIeNodeXFM1Incompatible` - XFM Module 1 is incompatible with this PCIe node.\n* `PCIeNodeXFM2Incompatible` - XFM Module 2 is incompatible with this PCIe node.\n* `PCIeNodeInInvalidSlot` - PCIe node has been installed in an unsupported slot.\n* `PCIeSlotPower` - The PCIe slot has hit a critical power fault.\n* `PCIeSlotAuxCableMissing` - The auxiliary power cable for this PCIe slot is missing.\n* `UnsupportedCardInPCIeSlot1` - An unsupported card has been detected in PCIe slot 1.\n* `UnsupportedCardInPCIeSlot2` - An unsupported card has been detected in PCIe slot 2.\n* `UnsupportedCardInPCIeSlot3` - An unsupported card has been detected in PCIe slot 3.\n* `UnsupportedCardInPCIeSlot4` - An unsupported card has been detected in PCIe slot 4.\n* `UnknownCardInPCIeSlot1` - An unknown card has been detected in PCIe slot 1.\n* `UnknownCardInPCIeSlot2` - An unknown card has been detected in PCIe slot 2.\n* `UnknownCardInPCIeSlot3` - An unknown card has been detected in PCIe slot 3.\n* `UnknownCardInPCIeSlot4` - An unknown card has been detected in PCIe slot 4.\n* `ZoneInvalidPcieDeviceRemoval` - PCIe zone invalidated due to PCIe devices removal.\n* `ZoneInvalidSlotCommunicationFailure` - PCIe zone invalidated due to communication failure with one or more slots.\n* `ZoneInvalidSwPowerFault` - PCIe zone invalidated due to switch power fault.\n* `ZoneInvalidSwCommunicationFailure` - PCIe zone invalidated due to switch communication failure.\n* `PeerNVLinkedGpuNotMapped` - Peer NVLinked GPU is not mapped to the server.\n* `GpuWrongSlotWarning` - GPU is installed in a wrong slot.\n* `ZonesRequireReconfig` - New PCIe zone creation blocked due to the existing PCIe zones and hardware limitations.\n* `Riser1GpuPidMismatch` - GPUs installed on riser 1 have different PIDs.\n* `Riser2GpuPidMismatch` - GPUs installed on riser 2 have different PIDs.\n* `Slot1PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 1 is invalid.\n* `Slot2PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 2 is invalid.\n* `Slot3PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 3 is invalid.\n* `Slot4PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 4 is invalid.\n* `Slot5PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 5 is invalid.\n* `Slot6PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 6 is invalid.\n* `Slot7PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 7 is invalid.\n* `Slot8PCIeDeviceMappingInvalid` - The PCIe device mapping for slot 8 is invalid.\n* `DriveHwIncompatible` - Physical drive is installed in a slot that is not supported by the server hardware.\n* `PresenceEquippedToMissing` - Oper reason value is set to this value when the device was equipped and was found missing later.", "type": "string", "enum": [ "Unknown", "OK", "Offline", "Missing", "HealthWarning", "HealthCritical", "TemperatureWarning", "TemperatureCritical", "InputVoltageWarning", "InputVoltageCritical", "OutputVoltageWarning", "OutputVoltageCritical", "OutputCurrentWarning", "OutputCurrentCritical", "SpeedWarning", "SpeedCritical", "FanMissingWarning", "FansMissingCritical", "IocardPostWarning", "AsicPostWarning", "TPMCritical", "FruStateCritical", "InbandIpv4ConflictCritical", "InbandIpv6ConflictCritical", "OutbandIpv4ConflictCritical", "OutbandIpv6ConflictCritical", "FruStateWarning", "AlternateImageWarning", "SelectedImageWarning", "SwitchHealthCritical", "LowMemoryCritical", "LowMemoryWarning", "PowerCritical", "PowerWarning", "ThermalSafeModeCritical", "PsuRedundancyLostCritical", "InputPowerWarning", "InputPowerCritical", "OutputPowerWarning", "OutputPowerCritical", "FanGeneralCritical", "PowerSupplyGeneralCritical", "PowerSupplyInputWarning", "PowerSupplyOutputCritical", "PowerSupplyInputLostWarning", "PowerSupplyUnresponsiveCritical", "PowerSupplyPredictiveFailure", "PowerSupplyDetectionFailure", "PsuFastOverCurrentWarning", "FanUnresponsiveCritical", "MemoryUncorrectableError", "MemoryTemperatureWarning", "MemoryTemperatureCritical", "MemoryBankError", "MemoryRankError", "MemoryPopError", "MemoryRasError", "MemoryMismatchError", "MemorySpdError", "MemoryBistError", "MemoryTypeError", "MemoryDisabledUnknownError", "MotherBoardPowerCritical", "MotherBoardTemperatureWarning", "MotherBoardTemperatureCritical", "MotherBoardVoltageWarning", "MotherBoardVoltageCritical", "MotherBoardPCHFuseFail", "MotherBoardCPLDImageVerificationFail", "LowLevelComponentFailure", "ProcessorCatErr", "ProcessorThermTrip", "ComponentNotOperational", "OperationalThroughFailover", "ComponentNotReachable", "ProcessorTemperatureWarning", "ProcessorTemperatureCritical", "ProcessorPowerCritical", "ProcessorInternalError", "ProcessorBISTFailure", "ProcessorHangInPOSTFailure", "ProcessorInitFailure", "ProcessorConfigurationFailure", "ProcessorSMBIOSUncorrectableCPUComplexError", "PCIeNodeRiserMismatch", "PCIeNodeRiser1Missing", "PCIeNodeRiser2PresentCPU2Absent", "PCIeNodePCIeLinkConfigIssue", "PCIeNodeRiser1PowerFault", "PCIeNodeRiser2PowerFault", "PCIeNodePowerFault", "PCIeNodeUnsupportedPCIeCardPresentOnRiser1", "PCIeNodeUnsupportedPCIeCardPresentOnRiser2", "PCIeNodeUnknownPCIeCardPresentOnRiser1", "PCIeNodeUnknownPCIeCardPresentOnRiser2", "PCIeNodePresentXFM1Absent", "InvalidConnections", "FexReplaced", "ThermalSafeModeCriticalServerSlot1", "ThermalSafeModeCriticalServerSlot2", "ThermalSafeModeCriticalServerSlot3", "ThermalSafeModeCriticalServerSlot4", "ThermalSafeModeCriticalServerSlot5", "ThermalSafeModeCriticalServerSlot6", "ThermalSafeModeCriticalServerSlot7", "ThermalSafeModeCriticalServerSlot8", "ThermalSafeModeCriticalXFM1", "ThermalSafeModeCriticalXFM2", "ThermalSafeModeCriticalIFM1", "ThermalSafeModeCriticalIFM2", "ChassisAvailablePowerInsufficient", "ChassisPowerBudgetInsufficient", "ChassisPowerInsufficient", "PowerBackupFailedCritical", "PowerBackupFailedWarning", "SpareCapacityWornOutCritical", "SpareCapacityWornOutWarning", "MediaInReadOnlyCritical", "MediaInReadOnlyWarning", "OverallSubsystemDegradedCritical", "OverallSubsystemDegradedWarning", "XFMUnsupportedCardInPCIeSlot1", "XFMUnsupportedCardInPCIeSlot2", "XFMUnknownCardInPCIeSlot1", "XFMUnknownCardInPCIeSlot2", "XFMPCIeSwitch1PowerFault", "XFMPCIeSwitch2PowerFault", "XFMPCIeSwitch1CommunicationFailure", "XFMPCIeSwitch2CommunicationFailure", "XFMComputeSlot1CommunicationFailure", "XFMComputeSlot2CommunicationFailure", "XFMComputeSlot3CommunicationFailure", "XFMComputeSlot4CommunicationFailure", "XFMComputeSlot5CommunicationFailure", "XFMComputeSlot6CommunicationFailure", "XFMComputeSlot7CommunicationFailure", "XFMComputeSlot8CommunicationFailure", "PCIeNodeHotswapController1Fault", "PCIeNodeHotswapController2Fault", "PCIeNodeDcBrick1Fault", "PCIeNodeDcBrick2Fault", "PCIeNodeXFM1Incompatible", "PCIeNodeXFM2Incompatible", "PCIeNodeInInvalidSlot", "PCIeSlotPower", "PCIeSlotAuxCableMissing", "UnsupportedCardInPCIeSlot1", "UnsupportedCardInPCIeSlot2", "UnsupportedCardInPCIeSlot3", "UnsupportedCardInPCIeSlot4", "UnknownCardInPCIeSlot1", "UnknownCardInPCIeSlot2", "UnknownCardInPCIeSlot3", "UnknownCardInPCIeSlot4", "ZoneInvalidPcieDeviceRemoval", "ZoneInvalidSlotCommunicationFailure", "ZoneInvalidSwPowerFault", "ZoneInvalidSwCommunicationFailure", "PeerNVLinkedGpuNotMapped", "GpuWrongSlotWarning", "ZonesRequireReconfig", "Riser1GpuPidMismatch", "Riser2GpuPidMismatch", "Slot1PCIeDeviceMappingInvalid", "Slot2PCIeDeviceMappingInvalid", "Slot3PCIeDeviceMappingInvalid", "Slot4PCIeDeviceMappingInvalid", "Slot5PCIeDeviceMappingInvalid", "Slot6PCIeDeviceMappingInvalid", "Slot7PCIeDeviceMappingInvalid", "Slot8PCIeDeviceMappingInvalid", "DriveHwIncompatible", "PresenceEquippedToMissing" ], "default": "Unknown", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OperState": { "description": "The current operational state of Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Operability": { "description": "The current operability state of Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "PhysicalBlockSize": { "description": "The block size of the the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ReadPolicy": { "description": "The read-ahead cache mode of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "SecurityFlags": { "description": "The security flags set for this virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Size": { "description": "The size of the virtual drive in MB.", "type": "string", "readOnly": true, "x-omitempty": true }, "StripSize": { "description": "The strip size is the portion of a stripe that resides on a single drive in the drive group, this is measured in KB.", "type": "string", "readOnly": true, "x-omitempty": true }, "Type": { "description": "The raid type of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The uuid of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "VendorUuid": { "description": "The UUID value of the vendor.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualDriveId": { "description": "The identifier for this Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "DiskGroup": { "$ref": "#/components/schemas/storage.DiskGroup.Relationship", "description": "A reference to a storageDiskGroup resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PhysicalDiskUsages": { "description": "An array of relationships to storagePhysicalDiskUsage resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.PhysicalDiskUsage.Relationship" }, "nullable": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageVirtualDriveContainer": { "$ref": "#/components/schemas/storage.VirtualDriveContainer.Relationship", "description": "A reference to a storageVirtualDriveContainer resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "VdMemberEps": { "description": "An array of relationships to storageVdMemberEp resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VdMemberEp.Relationship" }, "nullable": true, "readOnly": true }, "VirtualDriveExtension": { "$ref": "#/components/schemas/storage.VirtualDriveExtension.Relationship", "description": "A reference to a storageVirtualDriveExtension resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.VirtualDrive.List": { "title": "List of 'storage.VirtualDrive' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.VirtualDrive' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.VirtualDrive' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDrive" }, "nullable": true } } } ] }, "storage.VirtualDriveConfiguration": { "title": "Virtual Drive", "description": "Virtual Drive type models a single virtual drive that needs to be created through this policy.", "x-allOf-name": "storage.VirtualDriveConfiguration", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDriveConfiguration', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDriveConfiguration" ], "default": "storage.VirtualDriveConfiguration", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDriveConfiguration" ], "default": "storage.VirtualDriveConfiguration", "x-enum-as-string": true }, "BootDrive": { "description": "This flag enables this virtual drive to be used as a boot drive.", "type": "boolean", "x-omitempty": true }, "ExpandToAvailable": { "description": "This flag enables the virtual drive to use all the space available in the disk group. When this flag is enabled, the size property is ignored.", "type": "boolean", "x-omitempty": true }, "Name": { "description": "The name of the virtual drive. The name can be between 1 and 15 alphanumeric characters. Spaces or any special characters other than - (hyphen) and _ (underscore) are not allowed.", "type": "string", "pattern": "^[a-zA-Z0-9\\-_]*$", "maxLength": 15, "x-createOnly": true, "x-omitempty": true }, "Size": { "description": "Virtual drive size in MebiBytes. Size is mandatory field except when the Expand to Available option is enabled.", "type": "integer", "format": "int64", "minimum": 0, "x-omitempty": true }, "VirtualDrivePolicy": { "description": "This defines the characteristics of a specific virtual drive.", "$ref": "#/components/schemas/storage.VirtualDrivePolicy", "x-omitempty": true } } } ] }, "storage.VirtualDriveContainer.Response": { "description": "The response body of a HTTP GET request for the 'storage.VirtualDriveContainer' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.VirtualDriveContainer' resources.", "x-one-of-name": "storage.VirtualDriveContainer.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.VirtualDriveContainer.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.VirtualDriveContainer.Relationship": { "description": "A relationship to the 'storage.VirtualDriveContainer' resource, or the expanded 'storage.VirtualDriveContainer' resource, or the 'null' value.", "x-one-of-name": "storage.VirtualDriveContainer.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.VirtualDriveContainer" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.VirtualDriveContainer": { "title": "Storage:Virtual Drive Container", "description": "A Virtual Disk Drive Container.", "x-allOf-name": "storage.VirtualDriveContainer", "allOf": [ { "$ref": "#/components/schemas/equipment.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDriveContainer', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDriveContainer" ], "default": "storage.VirtualDriveContainer", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDriveContainer" ], "default": "storage.VirtualDriveContainer", "x-enum-as-string": true }, "ContainerId": { "description": "The identifier for this container.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "EquipmentChassis": { "$ref": "#/components/schemas/equipment.Chassis.Relationship", "description": "A reference to a equipmentChassis resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "VirtualDrive": { "description": "An array of relationships to storageVirtualDrive resources.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship" }, "nullable": true } } } ] }, "storage.VirtualDriveContainer.List": { "title": "List of 'storage.VirtualDriveContainer' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.VirtualDriveContainer' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.VirtualDriveContainer' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDriveContainer" }, "nullable": true } } } ] }, "storage.VirtualDriveExtension.Response": { "description": "The response body of a HTTP GET request for the 'storage.VirtualDriveExtension' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.VirtualDriveExtension' resources.", "x-one-of-name": "storage.VirtualDriveExtension.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.VirtualDriveExtension.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.VirtualDriveExtension.Relationship": { "description": "A relationship to the 'storage.VirtualDriveExtension' resource, or the expanded 'storage.VirtualDriveExtension' resource, or the 'null' value.", "x-one-of-name": "storage.VirtualDriveExtension.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/storage.VirtualDriveExtension" } ], "discriminator": { "propertyName": "ClassId" } }, "storage.VirtualDriveExtension": { "title": "Storage:Virtual Drive Extension", "description": "Information of virtual drives as reported by a storage controller. In certain cases like S-series servers, virtual drive information will be reported by the controller separately and this represents such information.", "x-allOf-name": "storage.VirtualDriveExtension", "allOf": [ { "$ref": "#/components/schemas/inventory.Base" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDriveExtension', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDriveExtension" ], "default": "storage.VirtualDriveExtension", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDriveExtension" ], "default": "storage.VirtualDriveExtension", "x-enum-as-string": true }, "Bootable": { "description": "The ability to boot from the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ContainerId": { "description": "The container id of the virtual drive.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "DriveState": { "description": "The state of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "The name of the Virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "OperDeviceId": { "description": "The operational device id of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "Uuid": { "description": "The UUID assigned to the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "VendorUuid": { "description": "The UUID value of the vendor assigned to the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualDriveDn": { "description": "The distinguished name of the virtual drive for which the extended data is provided.", "type": "string", "readOnly": true, "x-omitempty": true }, "VirtualDriveId": { "description": "The Id of the virtual drive.", "type": "string", "readOnly": true, "x-omitempty": true }, "InventoryDeviceInfo": { "$ref": "#/components/schemas/inventory.DeviceInfo.Relationship", "description": "A reference to a inventoryDeviceInfo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "RegisteredDevice": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "StorageController": { "$ref": "#/components/schemas/storage.Controller.Relationship", "description": "A reference to a storageController resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "VirtualDrive": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship", "description": "A reference to a storageVirtualDrive resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "storage.VirtualDriveExtension.List": { "title": "List of 'storage.VirtualDriveExtension' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.VirtualDriveExtension' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.VirtualDriveExtension' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDriveExtension" }, "nullable": true } } } ] }, "storage.VirtualDriveIdentity.Response": { "description": "The response body of a HTTP GET request for the 'storage.VirtualDriveIdentity' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'storage.VirtualDriveIdentity' resources.", "x-one-of-name": "storage.VirtualDriveIdentity.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/storage.VirtualDriveIdentity.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "storage.VirtualDriveIdentity": { "title": "VirtualDrive Identity Information", "description": "Identity object that uniquely represents a VirtualDrive object under a Server Profile.", "x-allOf-name": "storage.VirtualDriveIdentity", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDriveIdentity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDriveIdentity" ], "default": "storage.VirtualDriveIdentity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDriveIdentity" ], "default": "storage.VirtualDriveIdentity", "x-enum-as-string": true }, "Name": { "description": "The VirtualDrive Name which belongs to the Storage VirtualDrive.", "type": "string", "readOnly": true, "x-omitempty": true }, "ServerProfile": { "$ref": "#/components/schemas/server.Profile.Relationship", "description": "A reference to a serverProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "StoragePolicy": { "$ref": "#/components/schemas/storage.StoragePolicy.Relationship", "description": "A reference to a storageStoragePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "VirtualDrive": { "$ref": "#/components/schemas/storage.VirtualDrive.Relationship", "description": "A reference to a storageVirtualDrive resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "storage.VirtualDriveIdentity.List": { "title": "List of 'storage.VirtualDriveIdentity' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'storage.VirtualDriveIdentity' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'storage.VirtualDriveIdentity' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/storage.VirtualDriveIdentity" }, "nullable": true } } } ] }, "storage.VirtualDrivePolicy": { "title": "Storage:Virtual Drive Policy", "description": "This models the manual drive selection configuration.", "x-allOf-name": "storage.VirtualDrivePolicy", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'storage.VirtualDrivePolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "storage.VirtualDrivePolicy" ], "default": "storage.VirtualDrivePolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "storage.VirtualDrivePolicy" ], "default": "storage.VirtualDrivePolicy", "x-enum-as-string": true }, "AccessPolicy": { "description": "Access policy that host has on this virtual drive.\n* `Default` - Use platform default access mode.\n* `ReadWrite` - Enables host to perform read-write on the VD.\n* `ReadOnly` - Host can only read from the VD.\n* `Blocked` - Host can neither read nor write to the VD.", "type": "string", "enum": [ "Default", "ReadWrite", "ReadOnly", "Blocked" ], "default": "Default", "x-omitempty": true }, "DriveCache": { "description": "Disk cache policy for the virtual drive.\n* `Default` - Use platform default drive cache mode.\n* `NoChange` - Drive cache policy is unchanged.\n* `Enable` - Enables IO caching on the drive.\n* `Disable` - Disables IO caching on the drive.", "type": "string", "enum": [ "Default", "NoChange", "Enable", "Disable" ], "default": "Default", "x-omitempty": true }, "ReadPolicy": { "description": "Read ahead mode to be used to read data from this virtual drive.\n* `Default` - Use platform default read ahead mode.\n* `ReadAhead` - Use read ahead mode for the policy.\n* `NoReadAhead` - Do not use read ahead mode for the policy.", "type": "string", "enum": [ "Default", "ReadAhead", "NoReadAhead" ], "default": "Default", "x-omitempty": true }, "StripSize": { "description": "Desired strip size - Allowed values are 64KiB, 128KiB, 256KiB, 512KiB, 1024KiB.\n* `64` - Number of bytes in a strip is 64 Kibibytes.\n* `128` - Number of bytes in a strip is 128 Kibibytes.\n* `256` - Number of bytes in a strip is 256 Kibibytes.\n* `512` - Number of bytes in a strip is 512 Kibibytes.\n* `1024` - Number of bytes in a strip is 1024 Kibibytes or 1 Mebibyte.", "type": "integer", "enum": [ 64, 128, 256, 512, 1024 ], "default": 64, "x-omitempty": true }, "WritePolicy": { "description": "Write mode to be used to write data to this virtual drive.\n* `Default` - Use platform default write mode.\n* `WriteThrough` - Data is written through the cache and to the physical drives. Performance is improved, because subsequent reads of that data can be satisfied from the cache.\n* `WriteBackGoodBbu` - Data is stored in the cache, and is only written to the physical drives when space in the cache is needed. Virtual drives requesting this policy fall back to Write Through caching when the battery backup unit (BBU) cannot guarantee the safety of the cache in the event of a power failure.\n* `AlwaysWriteBack` - With this policy, write caching remains Write Back even if the battery backup unit is defective or discharged.", "type": "string", "enum": [ "Default", "WriteThrough", "WriteBackGoodBbu", "AlwaysWriteBack" ], "default": "Default", "x-omitempty": true } } } ] }, "storage.VolumeUtilization": { "title": "Storage:Volume Utilization", "description": "Storage space utilization of HyperFlex Volume entity.", "x-allOf-name": "storage.VolumeUtilization", "allOf": [ { "$ref": "#/components/schemas/storage.BaseCapacity" } ] }, "syslog.LocalClientBase": { "title": "Syslog:Local Client Base", "description": "Lists properties that are common to all local logging clients. It serves as base class for all local logging clients.", "x-allOf-name": "syslog.LocalClientBase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'syslog.LocalClientBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "syslog.LocalFileLoggingClient" ], "default": "syslog.LocalFileLoggingClient", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "syslog.LocalFileLoggingClient" ], "default": "syslog.LocalFileLoggingClient", "x-enum-as-string": true }, "MinSeverity": { "description": "Lowest level of messages to be included in the local log.\n* `warning` - Use logging level warning for logs classified as warning.\n* `emergency` - Use logging level emergency for logs classified as emergency.\n* `alert` - Use logging level alert for logs classified as alert.\n* `critical` - Use logging level critical for logs classified as critical.\n* `error` - Use logging level error for logs classified as error.\n* `notice` - Use logging level notice for logs classified as notice.\n* `informational` - Use logging level informational for logs classified as informational.\n* `debug` - Use logging level debug for logs classified as debug.", "type": "string", "enum": [ "warning", "emergency", "alert", "critical", "error", "notice", "informational", "debug" ], "default": "warning", "x-omitempty": true } } } ] }, "syslog.LocalFileLoggingClient": { "title": "Local Client", "description": "Local logging client on the endpoint.", "x-allOf-name": "syslog.LocalFileLoggingClient", "allOf": [ { "$ref": "#/components/schemas/syslog.LocalClientBase" } ] }, "syslog.Policy.Response": { "description": "The response body of a HTTP GET request for the 'syslog.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'syslog.Policy' resources.", "x-one-of-name": "syslog.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/syslog.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "syslog.Policy": { "title": "Syslog", "description": "The Syslog Policy is a reusable policy for configuring how system log messages are handled on an endpoint.\n#### Purpose\nThe purpose of this policy is to centralize and standardize the logging configuration for managed devices. It allows administrators to forward system logs to one or more remote syslog servers for aggregation, analysis, and long-term storage, which is essential for monitoring, troubleshooting, and security auditing.\n#### Key Concepts\n- **Remote and Local Logging:** The policy supports configuring both remote logging clients (to forward logs to a central server) and local logging clients (to control how logs are handled on the device itself).\n- **Multiple Destinations:** Administrators can define a list of remote syslog servers, each with its own specific configuration.\n- **Flexible Transport:** For remote logging, the policy supports both UDP and TCP as transport protocols.\n- **Severity Filtering:** It allows for the configuration of a minSeverity level for both local and remote logs, enabling administrators to filter out less important messages and reduce noise.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply a consistent logging configuration across multiple servers.", "x-allOf-name": "syslog.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'syslog.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "syslog.Policy" ], "default": "syslog.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "syslog.Policy" ], "default": "syslog.Policy", "x-enum-as-string": true }, "LocalClients": { "type": "array", "items": { "description": "Set of local logging clients on the endpoint.", "$ref": "#/components/schemas/syslog.LocalClientBase", "x-omitempty": true }, "minItems": 1, "nullable": true }, "RemoteClients": { "type": "array", "items": { "description": "Set of remote logging clients on the endpoint.", "$ref": "#/components/schemas/syslog.RemoteClientBase", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "syslog.Policy.List": { "title": "List of 'syslog.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'syslog.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'syslog.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/syslog.Policy" }, "nullable": true } } } ] }, "syslog.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'syslog.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'syslog.PolicyInventory' resources.", "x-one-of-name": "syslog.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/syslog.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "syslog.PolicyInventory": { "title": "Syslog", "description": "The Syslog Policy is a reusable policy for configuring how system log messages are handled on an endpoint.\n#### Purpose\nThe purpose of this policy is to centralize and standardize the logging configuration for managed devices. It allows administrators to forward system logs to one or more remote syslog servers for aggregation, analysis, and long-term storage, which is essential for monitoring, troubleshooting, and security auditing.\n#### Key Concepts\n- **Remote and Local Logging:** The policy supports configuring both remote logging clients (to forward logs to a central server) and local logging clients (to control how logs are handled on the device itself).\n- **Multiple Destinations:** Administrators can define a list of remote syslog servers, each with its own specific configuration.\n- **Flexible Transport:** For remote logging, the policy supports both UDP and TCP as transport protocols.\n- **Severity Filtering:** It allows for the configuration of a minSeverity level for both local and remote logs, enabling administrators to filter out less important messages and reduce noise.\n- **Profile-Based Application:** The policy is attached to a Server Profile to apply a consistent logging configuration across multiple servers.", "x-allOf-name": "syslog.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'syslog.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "syslog.PolicyInventory" ], "default": "syslog.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "syslog.PolicyInventory" ], "default": "syslog.PolicyInventory", "x-enum-as-string": true }, "LocalClients": { "type": "array", "items": { "description": "Set of local logging clients on the endpoint.", "$ref": "#/components/schemas/syslog.LocalClientBase", "readOnly": true, "x-omitempty": true }, "minItems": 1, "nullable": true }, "RemoteClients": { "type": "array", "items": { "description": "Set of remote logging clients on the endpoint.", "$ref": "#/components/schemas/syslog.RemoteClientBase", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "syslog.PolicyInventory.List": { "title": "List of 'syslog.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'syslog.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'syslog.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/syslog.PolicyInventory" }, "nullable": true } } } ] }, "syslog.RemoteClientBase": { "title": "Syslog:Remote Client Base", "description": "Lists properties that are common to all remote logging clients. It serves as a base class for all remote logging clients.", "x-allOf-name": "syslog.RemoteClientBase", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'syslog.RemoteClientBase', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "syslog.RemoteLoggingClient" ], "default": "syslog.RemoteLoggingClient", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "syslog.RemoteLoggingClient" ], "default": "syslog.RemoteLoggingClient", "x-enum-as-string": true }, "Enabled": { "description": "Enables/disables remote logging for the endpoint If enabled, log messages will be sent to the syslog server mentioned in the Hostname/IP Address field.", "type": "boolean", "default": true, "x-omitempty": true }, "Facility": { "description": "This component represents the process of the system which created the message.", "type": "string", "readOnly": true, "x-omitempty": true }, "Hostname": { "description": "Hostname or IP Address of the syslog server where log should be stored.", "type": "string", "x-omitempty": true }, "MinSeverity": { "description": "Lowest level of messages to be included in the remote log.\n* `warning` - Use logging level warning for logs classified as warning.\n* `emergency` - Use logging level emergency for logs classified as emergency.\n* `alert` - Use logging level alert for logs classified as alert.\n* `critical` - Use logging level critical for logs classified as critical.\n* `error` - Use logging level error for logs classified as error.\n* `notice` - Use logging level notice for logs classified as notice.\n* `informational` - Use logging level informational for logs classified as informational.\n* `debug` - Use logging level debug for logs classified as debug.", "type": "string", "enum": [ "warning", "emergency", "alert", "critical", "error", "notice", "informational", "debug" ], "default": "warning", "x-omitempty": true }, "Port": { "description": "Port number used for logging on syslog server.", "type": "integer", "format": "int64", "default": 514, "minimum": 1, "maximum": 65535, "x-omitempty": true }, "Protocol": { "description": "Transport layer protocol for transmission of log messages to syslog server.\n* `udp` - Use User Datagram Protocol (UDP) for syslog remote server connection.\n* `tcp` - Use Transmission Control Protocol (TCP) for syslog remote server connection.", "type": "string", "enum": [ "udp", "tcp" ], "default": "udp", "x-omitempty": true }, "VrfName": { "description": "VRF name used by the syslog server.", "type": "string", "readOnly": true, "x-omitempty": true } } } ] }, "syslog.RemoteLoggingClient": { "title": "Remote Client", "description": "Remote logging client for the endpoint.", "x-allOf-name": "syslog.RemoteLoggingClient", "allOf": [ { "$ref": "#/components/schemas/syslog.RemoteClientBase" } ] }, "tam.Action": { "title": "Tam:Action", "description": "An action is used to react when an object satifies the condition specified in alert query. For e.g. an action in case of an object matching a fieldNotice query would be to create an alert instance of type 'fieldNotice' for the affected object.", "x-allOf-name": "tam.Action", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.Action', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.Action" ], "default": "tam.Action", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.Action" ], "default": "tam.Action", "x-enum-as-string": true }, "AffectedObjectType": { "description": "Type of the managed object that should be marked with an instance of the Alert (when operation type is create) or that should have an alert instance removed (when operation type is remove).", "type": "string", "x-omitempty": true }, "AlertType": { "description": "Alert type is used to denote the category of an Intersight alert (FieldNotice, equipment Fault etc.).\n* `psirt` - Respresents the psirt alert type (https://tools.cisco.com/security/center/publicationListing.x).\n* `fieldNotice` - Respresents the field notice alert type (https://www.cisco.com/c/en/us/support/web/tsd-products-field-notice-summary.html).\n* `eolAdvisory` - Represents product End of Life (EOL) type (https://www.cisco.com/c/en/us/products/eos-eol-policy.html).", "type": "string", "enum": [ "psirt", "fieldNotice", "eolAdvisory" ], "default": "psirt", "x-omitempty": true }, "Identifiers": { "type": "array", "items": { "description": "Identifiers represents the filter criteria (property names and values) used to identify an Intersight managed object of type specified in affectedObjectType property. An instance of an alert is then create on (or removed from) the identified managed object.", "$ref": "#/components/schemas/tam.Identifiers", "x-omitempty": true }, "nullable": true }, "Name": { "description": "Uniquely identifies a given action among the set of actions corresponding to an advisory. Primarily used to store and compare results of subsequent iterations corresponding to the action queries.", "type": "string", "x-omitempty": true }, "OperationType": { "description": "Operation type for the alert action. An action is used to carry out the process of \"reacting\" to an alert condition. For e.g.in case of a fieldNotice alert, the intention may be to create a new alert (if the condition matches and there is no existing alert) or to remove an existing alert when the alert condition has been remedied.\n* `create` - Create an instance of AdvisoryInstance.\n* `remove` - Remove an instance of AdvisoryInstance.", "type": "string", "enum": [ "create", "remove" ], "default": "create", "x-omitempty": true }, "Queries": { "type": "array", "items": { "description": "Set of SparkSQL queries used determine if a given alert is applicable or not. Refer to https://spark.apache.org/sql/ for more details.", "$ref": "#/components/schemas/tam.QueryEntry", "x-omitempty": true }, "nullable": true }, "Type": { "description": "Type of Intersight alert. An alert in Intersight could be one of several kinds (FieldNotice, PSIRT etc.). Primarily used for filtering alerts based on the type.\n* `restApi` - Repesents the use of REST API for carrying out alert actions.", "type": "string", "enum": [ "restApi" ], "default": "restApi", "x-omitempty": true } } } ] }, "tam.AdvisoryCount.Response": { "description": "The response body of a HTTP GET request for the 'tam.AdvisoryCount' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'tam.AdvisoryCount' resources.", "x-one-of-name": "tam.AdvisoryCount.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/tam.AdvisoryCount.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "tam.AdvisoryCount": { "title": "Tam:Advisory Count", "description": "The AdvisoryCount object provides a high-level summary of the total number of advisories currently affecting a specific Intersight account.\n#### Purpose\nThis object serves as a quick-reference metric, allowing administrators to gauge the overall security and lifecycle posture of their infrastructure. By providing a consolidated count of active advisories\u2014such as Field Notices, PSIRT, or EOL milestones\u2014it enables organizations to prioritize their maintenance and remediation efforts effectively.\n#### Key Concepts\n- **Account-Level Aggregation:** Summarizes the total impact of all active advisories across the entire account, providing a single point of visibility for infrastructure health.\n- **Operational Visibility:** Offers a high-level dashboard metric that helps administrators quickly identify if there is a significant number of advisories requiring attention.\n- **License-Restricted Access:** Access to this object is governed by the 'Essentials' license entitlement, ensuring that capacity planning and maintenance monitoring are available to licensed users.\n- **Account Association:** Directly links the advisory count to a specific Intersight account, ensuring that the data is scoped correctly to the user's organizational context.", "x-allOf-name": "tam.AdvisoryCount", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.AdvisoryCount', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.AdvisoryCount" ], "default": "tam.AdvisoryCount", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.AdvisoryCount" ], "default": "tam.AdvisoryCount", "x-enum-as-string": true }, "AdvisoryCount": { "description": "Total number of advisories affecting the account.", "type": "integer", "format": "int64", "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "tam.AdvisoryCount.List": { "title": "List of 'tam.AdvisoryCount' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'tam.AdvisoryCount' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'tam.AdvisoryCount' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/tam.AdvisoryCount" }, "nullable": true } } } ] }, "tam.AdvisoryDefinition.Response": { "description": "The response body of a HTTP GET request for the 'tam.AdvisoryDefinition' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'tam.AdvisoryDefinition' resources.", "x-one-of-name": "tam.AdvisoryDefinition.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/tam.AdvisoryDefinition.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "tam.AdvisoryDefinition": { "title": "Tam:Advisory Definition", "description": "Global catalog of Field Notice / EOL / EOS advisories, NOT scoped to an account. To find which advisories impact an account or its servers, query tam.AdvisoryInstance instead; use this object only to look up a specific advisory's details by Moid or AdvisoryId.\nThe AdvisoryDefinition object is a critical component in Intersight. It encompasses various types of advisories, including Field Notices, End of Life (EOL), End of Sale (EOS), and End of Support advisories, each with specific recommendations for addressing them.\n#### Purpose\nAdvisoryDefinition provides a comprehensive framework for defining potential advisories that may impact managed objects in the datacenter. It delivers insights and guidance for handling Field Notices, EOL, EOS, and similar advisories effectively.\n#### Key Concepts\n- **Diverse Advisory Types:** Supports Field Notices, EOL, EOS, and other advisory types, each with tailored recommendations.\n- **Actionable Guidance:** Provides recommendations and potential workarounds to mitigate identified issues.\n- **Role-Based Access:** Access to create, update, or delete advisories is controlled through user privilege sets.", "x-allOf-name": "tam.AdvisoryDefinition", "allOf": [ { "$ref": "#/components/schemas/tam.BaseAdvisory" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.AdvisoryDefinition', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.AdvisoryDefinition" ], "default": "tam.AdvisoryDefinition", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.AdvisoryDefinition" ], "default": "tam.AdvisoryDefinition", "x-enum-as-string": true }, "Actions": { "type": "array", "items": { "description": "An array of actions that are to be taken when a given managed object matches the criteria specified for being affected by an alert definition.", "$ref": "#/components/schemas/tam.Action", "x-omitempty": true }, "nullable": true }, "AdvisoryDetails": { "description": "Additional details for the advisory definition. For e.g. if the definition corresponds to a security advisory, the details regarding CVE ids and CVSS score would be available here. If the definition is for an end-of-life milestone, the details about the specific milestone will be included.", "$ref": "#/components/schemas/tam.BaseAdvisoryDetails", "x-omitempty": true }, "AdvisoryId": { "description": "Cisco generated identifier for the published security/field-notice/end-of-life advisory.", "type": "string", "x-omitempty": true }, "ApiDataSources": { "type": "array", "items": { "description": "An array of data sources that are used to provide data for queries used to identify an Intersight alert applicability.", "$ref": "#/components/schemas/tam.ApiDataSource", "x-omitempty": true }, "nullable": true }, "DatePublished": { "description": "Date when the security/field-notice/end-of-life advisory was first published by Cisco.", "type": "string", "format": "date-time", "x-omitempty": true }, "DateUpdated": { "description": "Date when the security/field-notice/end-of-life advisory was last updated by Cisco.", "type": "string", "format": "date-time", "x-omitempty": true }, "ExecuteOnPod": { "description": "Orion pod on which this advisory should process.\n* `tier1` - Advisory processing will be taken care by batch processing.\n* `tier2` - Advisory processing will be taken care by stream processing.", "type": "string", "enum": [ "tier1", "tier2" ], "default": "tier1", "x-omitempty": true }, "ExternalUrl": { "description": "A link to an external URL describing security Advisory in more details.", "type": "string", "pattern": "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true }, "OtherRefUrls": { "type": "array", "items": { "description": "Reference URLs other then external URL.", "type": "string", "pattern": "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true }, "nullable": true }, "Recommendation": { "description": "Recommended action to resolve the security advisory.", "type": "string", "x-omitempty": true }, "S3DataSources": { "type": "array", "items": { "description": "An array of data sources that are used to provide data for queries used to identify an Intersight alert applicability.", "$ref": "#/components/schemas/tam.S3DataSource", "x-omitempty": true }, "nullable": true }, "Type": { "description": "The type (field notice, security advisory, end-of-life milestone advisory etc.) of Intersight advisory.\n* `securityAdvisory` - Respresents the psirt alert type (https://tools.cisco.com/security/center/publicationListing.x).\n* `fieldNotice` - Respresents the field notice alert type (https://www.cisco.com/c/en/us/support/web/tsd-products-field-notice-summary.html).\n* `eolAdvisory` - Represents product End of Life (EOL) type (https://www.cisco.com/c/en/us/products/eos-eol-policy.html).", "type": "string", "enum": [ "securityAdvisory", "fieldNotice", "eolAdvisory" ], "default": "securityAdvisory", "x-omitempty": true }, "Version": { "description": "Cisco assigned advisory/field-notice/end-of-life version after latest revision.", "type": "string", "x-omitempty": true }, "Workaround": { "description": "Workarounds available for the advisory.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "tam.AdvisoryDefinition.List": { "title": "List of 'tam.AdvisoryDefinition' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'tam.AdvisoryDefinition' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'tam.AdvisoryDefinition' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/tam.AdvisoryDefinition" }, "nullable": true } } } ] }, "tam.AdvisoryInfo.Response": { "description": "The response body of a HTTP GET request for the 'tam.AdvisoryInfo' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'tam.AdvisoryInfo' resources.", "x-one-of-name": "tam.AdvisoryInfo.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/tam.AdvisoryInfo.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "tam.AdvisoryInfo": { "title": "Tam:Advisory Info", "description": "Per-account acknowledgement bookkeeping for advisories; it records which advisories a user has acknowledged, and does not itself list the servers or components an advisory impacts (that is tam.AdvisoryInstance). A record is generally present only for advisories that have been acknowledged, so an advisory with no AdvisoryInfo record is simply unacknowledged. The reliable way to find unacknowledged advisories is therefore by exclusion - take the impacting advisories from tam.AdvisoryInstance and remove those whose Advisory is acknowledged here - rather than by querying this object for active records. Acknowledgement records can also persist after an advisory has stopped impacting the account, so a record here does not by itself mean the advisory still applies; when reporting acknowledged advisories that currently impact the account, intersect these acknowledged advisories with the ones actually present in tam.AdvisoryInstance. When asked how many advisories have been acknowledged, answer with that intersected count - the acknowledged advisories that currently impact the account - rather than the raw record total, unless the user explicitly asks for all acknowledgement records including ones no longer applicable.\nThe AdvisoryInfo object captures the state of Security Advisories and Field Notices, including whether an advisory is visible in the Intersight account, as depicted by its acknowledgement status.\n#### Purpose\nAdvisoryInfo serves as a personalized repository of advisory states for each account, allowing users to manage and track advisories relevant to their environment.\n#### Key Concepts\n- **State Management:** Tracks whether advisories are active or acknowledged, reflecting user preferences for updates.\n- **Account Association:** Directly links advisory states to specific accounts for tailored management.\n- **Shared Resource:** Supports collaborative management of advisories within shared organizational contexts.\n- **Controlled Permissions:** Restricts creation, updating, and deletion of advisory states to Account Administrators.", "x-allOf-name": "tam.AdvisoryInfo", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.AdvisoryInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.AdvisoryInfo" ], "default": "tam.AdvisoryInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.AdvisoryInfo" ], "default": "tam.AdvisoryInfo", "x-enum-as-string": true }, "State": { "description": "Current state of the advisory for the owner. Indicates if the user is interested in getting updates for the advisory. Because a record is usually created only when an advisory is acknowledged, the absence of an AdvisoryInfo record for an advisory means it is unacknowledged; this value is most reliably used to collect the acknowledged advisories ('acknowledged'), which can then be excluded from the impacting advisories in tam.AdvisoryInstance. An 'acknowledged' record may also be stale - it can remain after the advisory no longer impacts the account - so to report acknowledged advisories that still apply, intersect this acknowledged set with tam.AdvisoryInstance.\n* `active` - Advisory is currently active and the user wants to receive updates for this advisory.\n* `acknowledged` - Advisory is seen and acknowledged by the user and she no longer wants to recieve updates.", "type": "string", "enum": [ "active", "acknowledged" ], "default": "active", "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Advisory": { "$ref": "#/components/schemas/tam.BaseAdvisory.Relationship", "description": "A reference to a tamBaseAdvisory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "tam.AdvisoryInfo.List": { "title": "List of 'tam.AdvisoryInfo' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'tam.AdvisoryInfo' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'tam.AdvisoryInfo' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/tam.AdvisoryInfo" }, "nullable": true } } } ] }, "tam.AdvisoryInstance.Response": { "description": "The response body of a HTTP GET request for the 'tam.AdvisoryInstance' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'tam.AdvisoryInstance' resources.", "x-one-of-name": "tam.AdvisoryInstance.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/tam.AdvisoryInstance.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "tam.AdvisoryInstance": { "title": "Tam:Advisory Instance", "description": "The account-scoped record of which advisories (PSIRT security advisories, Field Notices, End-of-Life) currently impact an account and its servers or components. Unlike tam.SecurityAdvisory and tam.AdvisoryDefinition, which are global advisory catalogs and do not reflect account impact, this object exists only where an advisory applies to a managed object in the account.\nEach record represents a single advisory applied to a single managed object, so the record count reflects the number of impacts rather than the number of distinct advisories; an advisory affecting several objects produces several records that reference the same Advisory. Distinct advisories are obtained by grouping on the Advisory reference.\nAcknowledging an advisory does not remove its impact, so acknowledged advisories continue to appear here; acknowledgement is tracked separately on tam.AdvisoryInfo. The unacknowledged set is the advisories here whose Advisory is not acknowledged in tam.AdvisoryInfo, while acknowledged advisories remain part of an object's impact and are distinguished by their acknowledgement status rather than excluded.\nThe AdvisoryInstance object represents instances of advisories applicable to Intersight managed objects, \nmaintaining advisory applicability and state changes.\n#### Purpose\nAdvisoryInstance tracks the lifecycle and applicability of advisories for specific managed objects, \nensuring users have visibility into which devices or components are impacted and require resolution.\n#### Key Concepts\n- **Lifecycle Tracking:** Maintains records of advisory applicability, including state changes over time.\n- **Managed Object Integration:** Directly links advisories to affected managed objects for precise applicability.\n- **Controlled Access:** Provides access and management capabilities based on administrative privileges.", "x-allOf-name": "tam.AdvisoryInstance", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.AdvisoryInstance', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.AdvisoryInstance" ], "default": "tam.AdvisoryInstance", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.AdvisoryInstance" ], "default": "tam.AdvisoryInstance", "x-enum-as-string": true }, "AffectedObjectMoid": { "description": "Moid of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases.", "type": "string", "x-omitempty": true }, "AffectedObjectType": { "description": "Object type of the Intersight MO affected by the alert. Deprecated now and will be removed in subsequent releases.", "type": "string", "x-omitempty": true }, "LastStateChangeTime": { "description": "Timestamp when a state change was observed on this advisory instnace.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "LastVerifiedTime": { "description": "Timestamp when this advisory was last evaluated.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "State": { "description": "Deprecated and retained only for backward compatibility. This field is effectively always 'unknown' and does not reflect whether the advisory currently applies to the affected object. The existence of an AdvisoryInstance record is itself what denotes an applicable, current advisory impact, independent of this value.\n* `unknown` - Intersight is unable to determine if the Advisory instance is applicable for the affected managed object.\n* `active` - Advisory instance is currently active and applicable for the affected managed object.\n* `cleared` - Advisory instance is no longer applicable for the affected managed object.", "deprecated": true, "x-sunset": "2027-08-07", "type": "string", "enum": [ "unknown", "active", "cleared" ], "default": "unknown", "x-omitempty": true }, "Advisory": { "$ref": "#/components/schemas/tam.BaseAdvisory.Relationship", "description": "A reference to a tamBaseAdvisory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "AffectedObject": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceRegistration.Relationship", "description": "A reference to a assetDeviceRegistration resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "tam.AdvisoryInstance.List": { "title": "List of 'tam.AdvisoryInstance' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'tam.AdvisoryInstance' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'tam.AdvisoryInstance' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/tam.AdvisoryInstance" }, "nullable": true } } } ] }, "tam.ApiDataSource": { "title": "Tam:Api Data Source", "description": "Data source using Intersight API to collect data regarding managed devices.", "x-allOf-name": "tam.ApiDataSource", "allOf": [ { "$ref": "#/components/schemas/tam.BaseDataSource" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.ApiDataSource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.ApiDataSource" ], "default": "tam.ApiDataSource", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.ApiDataSource" ], "default": "tam.ApiDataSource", "x-enum-as-string": true }, "MoType": { "description": "Type of Intersight managed object used as data source.", "type": "string", "x-omitempty": true }, "Queries": { "type": "array", "items": { "description": "Optional set of Queries to filter the output for Api datasource. the queries are executed in the order specified.", "$ref": "#/components/schemas/tam.QueryEntry", "x-omitempty": true }, "nullable": true } } } ] }, "tam.BaseAdvisory.Relationship": { "description": "A relationship to the 'tam.BaseAdvisory' resource, or the expanded 'tam.BaseAdvisory' resource, or the 'null' value.", "x-one-of-name": "tam.BaseAdvisory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/tam.BaseAdvisory" } ], "discriminator": { "propertyName": "ClassId" } }, "tam.BaseAdvisory": { "title": "Tam:Base Advisory", "description": "An Intersight Advisory. An advisory represents an identification of a potential issue and may also include a recommendation for resolving the said issue. Advisories may be of different kind and severity. for e.g. It could be a security vulnerability or a performance issue or a hardware issue with different recommendations for resolving them.", "x-allOf-name": "tam.BaseAdvisory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.BaseAdvisory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.AdvisoryDefinition", "tam.SecurityAdvisory" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.AdvisoryDefinition", "tam.SecurityAdvisory" ], "x-enum-as-string": true }, "Description": { "description": "Brief description of the advisory details.", "type": "string", "x-omitempty": true }, "Name": { "description": "A user defined name for the Intersight Advisory.", "type": "string", "x-omitempty": true }, "Severity": { "description": "Severity level of the Intersight Advisory.", "$ref": "#/components/schemas/tam.Severity", "x-omitempty": true }, "State": { "description": "Current state of the advisory.\n* `ready` - Advisory has been evaluated. The affected devices would be analyzed and corresponding advisory instances would be created.\n* `evaluating` - Advisory is currently under evaluation. The affected devices would be analyzed but no advisory instances wouldbe created. The results of the analysis would be made available to Intersight engineering for evaluation and validation.", "type": "string", "enum": [ "ready", "evaluating" ], "default": "ready", "x-omitempty": true } } } ] }, "tam.BaseAdvisoryDetails": { "title": "Tam:Base Advisory Details", "description": "Base type for specifying advisory type (Field notice, PSIRT) specific details.", "x-allOf-name": "tam.BaseAdvisoryDetails", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.BaseAdvisoryDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.EolAdvisoryDetails", "tam.SecurityAdvisoryDetails" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.EolAdvisoryDetails", "tam.SecurityAdvisoryDetails" ], "x-enum-as-string": true }, "Description": { "description": "Brief description of details specified for an advisory type.", "type": "string", "x-omitempty": true } } } ] }, "tam.BaseDataSource": { "title": "Tam:Base Data Source", "description": "Represents source for the data needed to analyze the alerts. this could one of several supported source types (textFsmTemplates/Intersight API/external API). TextFsmTemplates and Intersight API are the only ones supported currently.", "x-allOf-name": "tam.BaseDataSource", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.BaseDataSource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.ApiDataSource", "tam.S3DataSource", "tam.TextFsmTemplateDataSource" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "tam.ApiDataSource", "tam.S3DataSource", "tam.TextFsmTemplateDataSource" ], "x-enum-as-string": true }, "Name": { "description": "Name is used to unique identify and refer a given data source in an alert definition.", "type": "string", "x-omitempty": true }, "Type": { "description": "Type of data source (for e.g. TextFsmTempalate based, Intersight API based etc.).\n* `intersightApi` - Collector type for this data collection is Intersight APIs.\n* `nxos` - Collector type for this data collection is NXOS.\n* `s3File` - Collector type for this data collection is a file in a cloud hosted object storage bucket.", "type": "string", "enum": [ "intersightApi", "nxos", "s3File" ], "default": "intersightApi", "x-omitempty": true } } } ] }, "tam.EolAdvisoryDetails": { "title": "Tam:Eol Advisory Details", "description": "Details pertaining to the milestone defined by an end-of-life (EOL) milestone advisory.", "x-allOf-name": "tam.EolAdvisoryDetails", "allOf": [ { "$ref": "#/components/schemas/tam.BaseAdvisoryDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.EolAdvisoryDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.EolAdvisoryDetails" ], "default": "tam.EolAdvisoryDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.EolAdvisoryDetails" ], "default": "tam.EolAdvisoryDetails", "x-enum-as-string": true }, "AllMilestones": { "type": "array", "items": { "description": "Full list of published milestones in timely order for this advisory. The current milestone is included.", "$ref": "#/components/schemas/tam.Milestone", "x-omitempty": true }, "nullable": true }, "Milestone": { "description": "A end-of-life advisory milestone as defined in Cisco end-of-life (EOL) policy (https://www.cisco.com/c/en/us/products/eos-eol-policy.html).", "$ref": "#/components/schemas/tam.Milestone", "x-omitempty": true }, "Release": { "description": "The name of the impacted release this advisory milestone intends to address, e.g. \"3.5 (2x)\".", "type": "string", "x-omitempty": true } } } ] }, "tam.EolSeverity": { "title": "Tam:Eol Severity", "description": "Severity level of an end-of-life (EOL) milestone advisory.", "x-allOf-name": "tam.EolSeverity", "allOf": [ { "$ref": "#/components/schemas/tam.Severity" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.EolSeverity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.EolSeverity" ], "default": "tam.EolSeverity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.EolSeverity" ], "default": "tam.EolSeverity", "x-enum-as-string": true }, "Level": { "description": "Severity level associated with an end-of-life (EOL) milestone advisory.\n* `info` - The end-of-life (EOL) milestone is at info level.\n* `critical` - The end-of-life (EOL) milestone is at critical level. It usually hints 'red' in a color-map.\n* `high` - The end-of-life (EOL) milestone is at high level.\n* `medium` - The end-of-life (EOL) milestone is at medium level.", "type": "string", "enum": [ "info", "critical", "high", "medium" ], "default": "info", "x-omitempty": true } } } ] }, "tam.FnSeverity": { "title": "Tam:Fn Severity", "description": "Severity level of field notice.", "x-allOf-name": "tam.FnSeverity", "allOf": [ { "$ref": "#/components/schemas/tam.Severity" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.FnSeverity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.FnSeverity" ], "default": "tam.FnSeverity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.FnSeverity" ], "default": "tam.FnSeverity", "x-enum-as-string": true }, "Level": { "description": "Severity level associated with a field notice.\n* `na` - < For field notices, where Severity or Impact rating is not applicable.\n* `critical` - < If applicable, customers may experience downtime or might be at risk of affecting services. Urgent attention and response action are desirable.\n* `high` - < If applicable, it may degrade or might have a potential degradation, Attention and response based on deployment scenarios.\n* `medium` - < If applicable, it may affect system performance or functionality but are less like to pose an immediate risk to the network. Actions to be taken in due course of time based on deployment scenarios.\n* `low` - < If applicable, Unlikely to expect disrupted functionality. Minor in nature and can be addressed as per convenience.", "type": "string", "enum": [ "na", "critical", "high", "medium", "low" ], "default": "na", "x-omitempty": true } } } ] }, "tam.Identifiers": { "title": "Tam:Identifiers", "description": "Identifiers are used to identify an affected object in an alert defition. please refer to https://Intersight.com/apidocs/introduction/#get-requests-and-query-capabilities for more details.", "x-allOf-name": "tam.Identifiers", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.Identifiers', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.Identifiers" ], "default": "tam.Identifiers", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.Identifiers" ], "default": "tam.Identifiers", "x-enum-as-string": true }, "Name": { "description": "Name of the filter paramter.", "type": "string", "x-omitempty": true }, "Value": { "description": "Value of the filter paramter.", "type": "string", "x-omitempty": true } } } ] }, "tam.Milestone": { "title": "Tam:Milestone", "description": "Cisco recognizes that end-of-life (EOL) milestones often prompt companies to review the way in which such milestones impact the Cisco products in their networks. With that in mind, Cisco has set out End of Product Lifecycle milestones to help manage the EOL transitions and to explain the role that Cisco can play in helping to migrate to alternative Cisco products and technology.", "x-allOf-name": "tam.Milestone", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.Milestone', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.Milestone" ], "default": "tam.Milestone", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.Milestone" ], "default": "tam.Milestone", "x-enum-as-string": true }, "Date": { "description": "Date when the specified end-of-life milestone advisory is reached.", "type": "string", "format": "date-time", "x-omitempty": true }, "Description": { "description": "A description of the milestone defined by an end-of-life advisory.", "type": "string", "x-omitempty": true }, "EndOffset": { "description": "Number of days (exclusive) relative to the milestone date when the milestone is considered to be not in effect. A nagative number indicates number of days ahead of the milestone date. The default is 2147483647 (0x7FFFFFFF) which means the milestone date range's upper bound is omitted.", "type": "integer", "format": "int32", "default": 2147483647, "x-omitempty": true }, "LabelHint": { "description": "Extra hint to the type of label to be used in display in addition to severity and effective date. How to use it is at UI's descretion.\n* `upcoming` - This end-of-life (EOL) milestone is upcoming. The label may be changed to more urgent type such as 'imminent' as time progress approaching effective date.\n* `imminent` - This end-of-life (EOL) milestone is imminent. There will be no label change before the effective date.\n* `past` - This end-of-life (EOL) milestone has past the effective date.\n* `info` - This end-of-life (EOL) milestone for informative purpose.", "type": "string", "enum": [ "upcoming", "imminent", "past", "info" ], "default": "upcoming", "x-omitempty": true }, "MilestoneType": { "description": "Milestone type as defined in Cisco end-of-life (EOL) policy (https://www.cisco.com/c/en/us/products/eos-eol-policy.html) when the specified end-of-life milestone advisory is reached.\n* `unknown` - The type of end-of-life milestone is not defined.\n* `endOfSoftwareMaintenanceDate` - The last date that Cisco Engineering may release any final software maintenance releases or bug fixes. After this date, Cisco Engineering may no longer develop, repair, maintain, or test the product software and only critical security updates will be provided on this release train. \n* `lastDateOfSupport` - The last date to receive service and support for the software. After this date, all support services for the software are unavailable, and the software becomes obsolete. \n* `endOfLifeAnnouncementDate` - The date the document that announces the end-of-sale and end-of-life of a product is distributed to the general public.", "type": "string", "enum": [ "unknown", "endOfSoftwareMaintenanceDate", "lastDateOfSupport", "endOfLifeAnnouncementDate" ], "default": "unknown", "x-omitempty": true }, "Name": { "description": "A milestone defined by an end-of-life advisory.", "type": "string", "x-omitempty": true }, "StartOffset": { "description": "Number of days (inclusive) relative to the milestone date when the milestone is considered to be in effect. A nagative number indicates number of days ahead of the milestone date. The default is 0 which means the milestone take effect exactly on the same date as the specified milestone date. A negative value of -2147483648 (0x80000000) indicates the milestone date range's lower bound is omitted.", "type": "integer", "format": "int32", "default": 0, "x-omitempty": true } } } ] }, "tam.PsirtSeverity": { "title": "Tam:Psirt Severity", "description": "< Severity level of a security advisory. Each advisory type (psirt/field notice etc.) may have a different method of calculating the severity. For e.g. a PSIRT severity may depend upon the corresponding CVSS score where as field notices are always critical in nature.", "x-allOf-name": "tam.PsirtSeverity", "allOf": [ { "$ref": "#/components/schemas/tam.Severity" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.PsirtSeverity', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.PsirtSeverity" ], "default": "tam.PsirtSeverity", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.PsirtSeverity" ], "default": "tam.PsirtSeverity", "x-enum-as-string": true }, "Level": { "description": "Severity level associated with the security advisory.\n* `critical` - < If applicable, it may expose users to critical failures and it needs to be addressed immediately. For e.g. a PSIRT advisory with a corresponding CVSS score of above 9.0.\n* `high` - < If applicable, it may expose the users to critical failure and it needs to be addressed immediately. For e.g. a PSIRT advisory with a corresponding CVSS score between 7.0-8.9. These may be the vulnerabilities that are more difficult to exploit than the ones deemed critical but once exploited, the will cause critical failures.\n* `medium` - < If applicable, it may expose the users to failure of certain functions. for e.g. a PSIRT advisory with a corresponding CVSS score between 4.0-6.9. These may be the vulnerabilities that are mitigated to a large extent but that may still be exploited in certain restricted cases.\n* `info` - < If applicable, it may have some minimal impact for certain functions in the user environment. For e.g. a PSIRT advisory with a corresponding CVSS score below 4.0.", "type": "string", "enum": [ "critical", "high", "medium", "info" ], "default": "critical", "x-omitempty": true } } } ] }, "tam.QueryEntry": { "title": "Tam:Query Entry", "description": "Contains a set of queries, each with an integer priority. the queries are executed in the order of specified priority. The result of each query is used as an input to the query next in priority order.", "x-allOf-name": "tam.QueryEntry", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.QueryEntry', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.QueryEntry" ], "default": "tam.QueryEntry", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.QueryEntry" ], "default": "tam.QueryEntry", "x-enum-as-string": true }, "Name": { "description": "Name is used to unique identify and result of the given query which can be used by subsequent queries as input data source.", "type": "string", "x-omitempty": true }, "Priority": { "description": "An integer value depicting the priority of the query among the queries that are part of the same QueryEntry collection.", "type": "integer", "format": "int64", "x-omitempty": true }, "Query": { "description": "A SparkSQL query to be used on a given data source.", "type": "string", "x-omitempty": true } } } ] }, "tam.S3DataSource": { "title": "Tam:S3 Data Source", "description": "S3 based data source used for storing data regarding managed devices.", "x-allOf-name": "tam.S3DataSource", "allOf": [ { "$ref": "#/components/schemas/tam.BaseDataSource" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.S3DataSource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.S3DataSource" ], "default": "tam.S3DataSource", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.S3DataSource" ], "default": "tam.S3DataSource", "x-enum-as-string": true }, "Queries": { "type": "array", "items": { "description": "Optional set of Queries to filter the output for Api datasource. the queries are executed in the order specified.", "$ref": "#/components/schemas/tam.QueryEntry", "x-omitempty": true }, "nullable": true }, "S3Path": { "description": "Path used to access file in s3 containing data.", "type": "string", "x-omitempty": true } } } ] }, "tam.SecurityAdvisory.Response": { "description": "The response body of a HTTP GET request for the 'tam.SecurityAdvisory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'tam.SecurityAdvisory' resources.", "x-one-of-name": "tam.SecurityAdvisory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/tam.SecurityAdvisory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "tam.SecurityAdvisory": { "title": "Tam:Security Advisory", "description": "Global catalog of PSIRT advisories, NOT scoped to an account. To find which advisories impact an account or its servers, query tam.AdvisoryInstance instead; use this object only to look up a specific advisory's details (CVEs, CVSS) by Moid or AdvisoryId.\nThe SecurityAdvisory object represents the Intersight adaptation of Cisco PSIRT advisories, focusing on security issues with associated CVE identifiers and CVSS scores. It helps users identify and address security vulnerabilities within their managed objects.\n#### Purpose\nSecurityAdvisory provides a structured representation of security advisories, enabling users to understand vulnerabilities and take appropriate actions to secure their systems.\n#### Key Concepts\n- **PSIRT Integration:** Aligns with Cisco's PSIRT advisories for comprehensive security coverage.\n- **Detailed Severity Assessment:** Uses CVE identifiers and CVSS scores to quantify the severity of vulnerabilities.\n- **Access Control and Management:** Ensures that only authorized personnel can manage security advisories.", "x-allOf-name": "tam.SecurityAdvisory", "allOf": [ { "$ref": "#/components/schemas/tam.BaseAdvisory" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.SecurityAdvisory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.SecurityAdvisory" ], "default": "tam.SecurityAdvisory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.SecurityAdvisory" ], "default": "tam.SecurityAdvisory", "x-enum-as-string": true }, "Actions": { "type": "array", "items": { "description": "An array of actions that are to be taken when a given managed object matches the criteria specified for being affected by an alert definition.", "$ref": "#/components/schemas/tam.Action", "x-omitempty": true }, "nullable": true }, "AdvisoryId": { "description": "Cisco generated identifier for the published security advisory.", "type": "string", "x-omitempty": true }, "ApiDataSources": { "type": "array", "items": { "description": "An array of data sources that are used to provide data for queries used to identify an Intersight alert applicability.", "$ref": "#/components/schemas/tam.ApiDataSource", "x-omitempty": true }, "nullable": true }, "BaseScore": { "description": "CVSS version 3 base score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true }, "CveIds": { "type": "array", "items": { "description": "CVE (https://cve.mitre.org/about/faqs.html) identifiers associated with the published security Advisory.", "type": "string", "pattern": "^$|CVE-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]+", "x-omitempty": true }, "nullable": true }, "DatePublished": { "description": "Date when the security advisory was first published by Cisco.", "type": "string", "format": "date-time", "x-omitempty": true }, "DateUpdated": { "description": "Date when the security advisory was last updated by Cisco.", "type": "string", "format": "date-time", "x-omitempty": true }, "EnvironmentalScore": { "description": "CVSS version 3 environmental score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true }, "ExecuteOnPod": { "description": "Orion pod on which this advisory should process.\n* `tier1` - Advisory processing will be taken care by batch processing.\n* `tier2` - Advisory processing will be taken care by stream processing.", "type": "string", "enum": [ "tier1", "tier2" ], "default": "tier1", "x-omitempty": true }, "ExternalUrl": { "description": "A link to an external URL describing security Advisory in more details.", "type": "string", "pattern": "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true }, "OtherRefUrls": { "type": "array", "items": { "description": "Reference URLs other then external URL.", "type": "string", "pattern": "^$|^(?:http(s)?:\\/\\/)?[\\w.-]+(?:\\.[\\w\\.-]+)+[\\w\\-\\._~:/?#[\\]@!\\$&'\\(\\)\\*\\+,;=.]+$", "x-omitempty": true }, "nullable": true }, "Recommendation": { "description": "Recommended action to resolve the security advisory.", "type": "string", "x-omitempty": true }, "Status": { "description": "Cisco assigned status of the published advisory based on whether the investigation is complete or on-going.\n* `interim` - The Cisco investigation for the advisory is ongoing. Cisco will issue revisions to the advisory when additional information, including fixed software release data, becomes available.\n* `final` - Cisco has completed its evaluation of the vulnerability described in the advisory. There will be no further updates unless there is a material change in the nature of the vulnerability.", "type": "string", "enum": [ "interim", "final" ], "default": "interim", "x-omitempty": true }, "TemporalScore": { "description": "CVSS version 3 temporal score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true }, "Version": { "description": "Cisco assigned advisory version after latest revision.", "type": "string", "x-omitempty": true }, "Workaround": { "description": "Workarounds available for the advisory.", "type": "string", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "tam.SecurityAdvisory.List": { "title": "List of 'tam.SecurityAdvisory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'tam.SecurityAdvisory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'tam.SecurityAdvisory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/tam.SecurityAdvisory" }, "nullable": true } } } ] }, "tam.SecurityAdvisoryDetails": { "title": "Tam:Security Advisory Details", "description": "Details pertaining to a security advisory defined by a given advisory.", "x-allOf-name": "tam.SecurityAdvisoryDetails", "allOf": [ { "$ref": "#/components/schemas/tam.BaseAdvisoryDetails" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.SecurityAdvisoryDetails', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.SecurityAdvisoryDetails" ], "default": "tam.SecurityAdvisoryDetails", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.SecurityAdvisoryDetails" ], "default": "tam.SecurityAdvisoryDetails", "x-enum-as-string": true }, "BaseScore": { "description": "CVSS version 3 base score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true }, "CveIds": { "type": "array", "items": { "description": "CVE (https://cve.mitre.org/about/faqs.html) identifiers associated with the published security Advisory.", "type": "string", "pattern": "^$|CVE-[0-9][0-9][0-9][0-9]-[0-9][0-9][0-9][0-9]+", "x-omitempty": true }, "nullable": true }, "EnvironmentalScore": { "description": "CVSS version 3 environmental score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true }, "Status": { "description": "Cisco assigned status of the published advisory. Depends on whether the investigation is complete or on-going.\n* `interim` - The Cisco investigation for the advisory is ongoing. Cisco will issue revisions to the advisory when additional information, including fixed software release data, becomes available.\n* `final` - Cisco has completed its evaluation of the vulnerability described in the advisory. There will be no further updates unless there is a material change in the nature of the vulnerability.", "type": "string", "enum": [ "interim", "final" ], "default": "interim", "x-omitempty": true }, "TemporalScore": { "description": "CVSS version 3 temporal score for the security Advisory.", "type": "number", "format": "float", "minimum": 0.0, "maximum": 10.0, "x-omitempty": true } } } ] }, "tam.Severity": { "title": "Tam:Severity", "description": "< Severity associated with the advisory. Severity assignment and interpretation is specific to each type of advisory. Each advisory type (SecurityAdvisory etc.) is supposed to extend and implement Severity type based on the advisory type requirements.", "x-allOf-name": "tam.Severity", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" } ] }, "tam.TextFsmTemplateDataSource": { "title": "Tam:Text Fsm Template Data Source", "description": "TextFsmTemplate based data source used for data collection from the managed devices.", "x-allOf-name": "tam.TextFsmTemplateDataSource", "allOf": [ { "$ref": "#/components/schemas/tam.BaseDataSource" }, { "type": "object", "description": "Definition of the list of properties defined in 'tam.TextFsmTemplateDataSource', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "tam.TextFsmTemplateDataSource" ], "default": "tam.TextFsmTemplateDataSource", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "tam.TextFsmTemplateDataSource" ], "default": "tam.TextFsmTemplateDataSource", "x-enum-as-string": true }, "Cmd": { "description": "Command used to gather data needed to evaluate field notice applicability.", "type": "string", "x-omitempty": true } } } ] }, "terminal.AuditLog.Response": { "description": "The response body of a HTTP GET request for the 'terminal.AuditLog' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'terminal.AuditLog' resources.", "x-one-of-name": "terminal.AuditLog.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/terminal.AuditLog.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "terminal.AuditLog": { "title": "Terminal:Audit Log", "description": "The AuditLog object captures and records the audit trail of remote terminal user sessions. This provides a comprehensive history of user interactions with terminal sessions, ensuring accountability and traceability of actions performed.\n#### Purpose\nThe primary purpose of an AuditLog is to maintain a detailed record of all remote terminal user sessions. This record is crucial for security, compliance, and troubleshooting, allowing administrators to review who accessed what, when, and for how long, thereby ensuring operational transparency and accountability.\n#### Key Concepts\n- **Session Tracking:** Records key events and timestamps related to the opening and closing of terminal sessions. \n- **Accountability:** The audit log object records only the session metadata, specifically the start and end times for a given user and device. It does not capture or retain the detailed contents of the session itself. \n- **Security and Compliance:** Supports auditing requirements by offering a clear and immutable log of session activities.", "x-allOf-name": "terminal.AuditLog", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'terminal.AuditLog', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "terminal.AuditLog" ], "default": "terminal.AuditLog", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "terminal.AuditLog" ], "default": "terminal.AuditLog", "x-enum-as-string": true }, "EndTime": { "description": "The time the terminal was closed. If terminal has not closed, value is zero time.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "StartTime": { "description": "The time the terminal session was opened.", "type": "string", "format": "date-time", "readOnly": true, "x-omitempty": true }, "DeviceRegistration": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/asset.DeviceConnection.Relationship", "description": "A reference to a assetDeviceConnection resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "User": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.User.Relationship", "description": "A reference to a iamUser resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "terminal.AuditLog.List": { "title": "List of 'terminal.AuditLog' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'terminal.AuditLog' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'terminal.AuditLog' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/terminal.AuditLog" }, "nullable": true } } } ] }, "thermal.Policy.Response": { "description": "The response body of a HTTP GET request for the 'thermal.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'thermal.Policy' resources.", "x-one-of-name": "thermal.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/thermal.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "thermal.Policy": { "title": "Thermal", "description": "The Thermal Policy is a reusable policy for managing the thermal and fan control settings of a server or chassis.\n#### Purpose\nThe purpose of this policy is to allow administrators to define a cooling strategy for their hardware. By selecting a specific fan control mode, they can balance the trade-offs between cooling performance, power consumption, and acoustic noise to best suit the operating environment and workload requirements.\n#### Key Concepts\n- **Fan Control Mode:** The core of the policy is the fanControlMode setting, which offers several presets (e.g., Balanced, Low Power, Maximum Cooling, Acoustic) to dictate fan speed behavior.\n- **Chassis and Server Application:** The policy can be applied to both Server Profiles and Chassis Profiles, allowing for consistent thermal management at both the individual server and chassis levels.\n- **Platform-Specific Options:** The available fan control modes can vary depending on the server or chassis model (e.g., certain modes are exclusive to UCS X-Series).\n- **Profile-Based Management:** As a policy object, it ensures that all devices associated with a profile adhere to the same thermal strategy.", "x-allOf-name": "thermal.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'thermal.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "thermal.Policy" ], "default": "thermal.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "thermal.Policy" ], "default": "thermal.Policy", "x-enum-as-string": true }, "FanControlMode": { "description": "Sets the Fan Control Mode. High Power, Maximum Power and Acoustic modes are supported only on the Cisco UCS C-Series servers and on the X-Series Chassis. Maximum cooling mode is only supported on Unified Edge platforms and Cisco UCS C-Series M7+ servers running firmware 4.3 (5.250001) or later. C480M5 does not support Acoustic mode.\n* `Balanced` - The fans run faster when needed based on the heat generated by the server. When possible, the fans returns to the minimum required speed.\n* `LowPower` - The Fans run at the minimum speed required to keep the server cool.\n* `HighPower` - The fans are kept at higher speed to emphasizes performance over power consumption. This Mode is only supported for UCS X series Chassis.\n* `MaximumPower` - The fans are always kept at maximum speed. This option provides the most cooling and consumes the most power. This Mode is only supported for UCS X series Chassis.\n* `Acoustic` - The fan speed is reduced to reduce noise levels in acoustic-sensitive environments. This Mode is only supported for UCS X series Chassis.\n* `MaximumCooling` - The fan speed is kept for maximum cooling. This mode is only supported for Cisco UCS C-Series server models M7 and above for server firmware 4.3 (5.250001) and later.", "type": "string", "enum": [ "Balanced", "LowPower", "HighPower", "MaximumPower", "Acoustic", "MaximumCooling" ], "default": "Balanced", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "thermal.Policy.List": { "title": "List of 'thermal.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'thermal.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'thermal.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/thermal.Policy" }, "nullable": true } } } ] }, "thermal.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'thermal.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'thermal.PolicyInventory' resources.", "x-one-of-name": "thermal.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/thermal.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "thermal.PolicyInventory": { "title": "Thermal", "description": "The Thermal Policy is a reusable policy for managing the thermal and fan control settings of a server or chassis.\n#### Purpose\nThe purpose of this policy is to allow administrators to define a cooling strategy for their hardware. By selecting a specific fan control mode, they can balance the trade-offs between cooling performance, power consumption, and acoustic noise to best suit the operating environment and workload requirements.\n#### Key Concepts\n- **Fan Control Mode:** The core of the policy is the fanControlMode setting, which offers several presets (e.g., Balanced, Low Power, Maximum Cooling, Acoustic) to dictate fan speed behavior.\n- **Chassis and Server Application:** The policy can be applied to both Server Profiles and Chassis Profiles, allowing for consistent thermal management at both the individual server and chassis levels.\n- **Platform-Specific Options:** The available fan control modes can vary depending on the server or chassis model (e.g., certain modes are exclusive to UCS X-Series).\n- **Profile-Based Management:** As a policy object, it ensures that all devices associated with a profile adhere to the same thermal strategy.", "x-allOf-name": "thermal.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'thermal.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "thermal.PolicyInventory" ], "default": "thermal.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "thermal.PolicyInventory" ], "default": "thermal.PolicyInventory", "x-enum-as-string": true }, "AggressiveCooling": { "description": "Sets the Aggressive Cooling to Enable/Disable.\n* `Disabled` - Set the value to Disabled.\n* `Enabled` - Set the value to Enabled.", "type": "string", "enum": [ "Disabled", "Enabled" ], "default": "Disabled", "readOnly": true, "x-omitempty": true }, "FanControlMode": { "description": "Sets the Fan Control Mode. High Power, Maximum Power and Acoustic modes are supported only on the Cisco UCS C-Series servers and on the X-Series Chassis. Maximum cooling mode is only supported on Unified Edge platforms and Cisco UCS C-Series M7+ servers running firmware 4.3 (5.250001) or later. C480M5 does not support Acoustic mode.\n* `Balanced` - The fans run faster when needed based on the heat generated by the server. When possible, the fans returns to the minimum required speed.\n* `LowPower` - The Fans run at the minimum speed required to keep the server cool.\n* `HighPower` - The fans are kept at higher speed to emphasizes performance over power consumption. This Mode is only supported for UCS X series Chassis.\n* `MaximumPower` - The fans are always kept at maximum speed. This option provides the most cooling and consumes the most power. This Mode is only supported for UCS X series Chassis.\n* `Acoustic` - The fan speed is reduced to reduce noise levels in acoustic-sensitive environments. This Mode is only supported for UCS X series Chassis.\n* `MaximumCooling` - The fan speed is kept for maximum cooling. This mode is only supported for Cisco UCS C-Series server models M7 and above for server firmware 4.3 (5.250001) and later.", "type": "string", "enum": [ "Balanced", "LowPower", "HighPower", "MaximumPower", "Acoustic", "MaximumCooling" ], "default": "Balanced", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "thermal.PolicyInventory.List": { "title": "List of 'thermal.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'thermal.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'thermal.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/thermal.PolicyInventory" }, "nullable": true } } } ] }, "uuidpool.Block.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.Block' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.Block' resources.", "x-one-of-name": "uuidpool.Block.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.Block.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.Block.Relationship": { "description": "A relationship to the 'uuidpool.Block' resource, or the expanded 'uuidpool.Block' resource, or the 'null' value.", "x-one-of-name": "uuidpool.Block.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.Block" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.Block": { "title": "Uuidpool:Block", "description": "A block of contiguous UUID addresses that are part of a pool.", "x-allOf-name": "uuidpool.Block", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlock" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.Block', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.Block" ], "default": "uuidpool.Block", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.Block" ], "default": "uuidpool.Block", "x-enum-as-string": true }, "Prefix": { "description": "Prefix of the UUID pool. UUID is constructed as -.", "type": "string", "readOnly": true, "x-omitempty": true }, "UuidSuffixBlock": { "description": "A block of UUID addresses.", "$ref": "#/components/schemas/uuidpool.UuidBlock", "x-omitempty": true }, "Pool": { "$ref": "#/components/schemas/uuidpool.Pool.Relationship", "description": "A reference to a uuidpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservations": { "description": "An array of relationships to uuidpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Reservation.Relationship" }, "nullable": true, "readOnly": true } } } ] }, "uuidpool.Block.List": { "title": "List of 'uuidpool.Block' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.Block' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.Block' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Block" }, "nullable": true } } } ] }, "uuidpool.Pool.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.Pool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.Pool' resources.", "x-one-of-name": "uuidpool.Pool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.Pool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.Pool.Relationship": { "description": "A relationship to the 'uuidpool.Pool' resource, or the expanded 'uuidpool.Pool' resource, or the 'null' value.", "x-one-of-name": "uuidpool.Pool.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.Pool" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.Pool": { "title": "Uuidpool:Pool", "description": "Pool represents a collection of UUID items that can be allocated to server profiles.", "x-allOf-name": "uuidpool.Pool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractPool" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.Pool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.Pool" ], "default": "uuidpool.Pool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.Pool" ], "default": "uuidpool.Pool", "x-enum-as-string": true }, "Prefix": { "description": "The UUID prefix must be in hexadecimal format xxxxxxxx-xxxx-xxxx.", "type": "string", "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}$", "x-omitempty": true }, "UuidSuffixBlocks": { "type": "array", "items": { "description": "Collection of UUID suffix blocks.", "$ref": "#/components/schemas/uuidpool.UuidBlock", "x-omitempty": true }, "nullable": true }, "BlockHeads": { "description": "An array of relationships to uuidpoolBlock resources.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Block.Relationship" }, "nullable": true, "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Reservations": { "description": "An array of relationships to uuidpoolReservation resources.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Reservation.Relationship" }, "nullable": true } } } ] }, "uuidpool.Pool.List": { "title": "List of 'uuidpool.Pool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.Pool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.Pool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Pool" }, "nullable": true } } } ] }, "uuidpool.PoolMember.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.PoolMember' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.PoolMember' resources.", "x-one-of-name": "uuidpool.PoolMember.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.PoolMember.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.PoolMember.Relationship": { "description": "A relationship to the 'uuidpool.PoolMember' resource, or the expanded 'uuidpool.PoolMember' resource, or the 'null' value.", "x-one-of-name": "uuidpool.PoolMember.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.PoolMember" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.PoolMember": { "title": "Uuidpool:Pool Member", "description": "PoolMember represents a single UUID that is part of a pool.", "x-allOf-name": "uuidpool.PoolMember", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractIdPoolMember" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.PoolMember', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.PoolMember" ], "default": "uuidpool.PoolMember", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.PoolMember" ], "default": "uuidpool.PoolMember", "x-enum-as-string": true }, "Uuid": { "description": "UUID Prefix+Suffix of this PoolMember.", "type": "string", "readOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "BlockHead": { "$ref": "#/components/schemas/uuidpool.Block.Relationship", "description": "A reference to a uuidpoolBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Peer": { "$ref": "#/components/schemas/uuidpool.UuidLease.Relationship", "description": "A reference to a uuidpoolUuidLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Pool": { "$ref": "#/components/schemas/uuidpool.Pool.Relationship", "description": "A reference to a uuidpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Reservation": { "$ref": "#/components/schemas/uuidpool.Reservation.Relationship", "description": "A reference to a uuidpoolReservation resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "uuidpool.PoolMember.List": { "title": "List of 'uuidpool.PoolMember' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.PoolMember' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.PoolMember' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.PoolMember" }, "nullable": true } } } ] }, "uuidpool.Reservation.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.Reservation' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.Reservation' resources.", "x-one-of-name": "uuidpool.Reservation.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.Reservation.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.Reservation.Relationship": { "description": "A relationship to the 'uuidpool.Reservation' resource, or the expanded 'uuidpool.Reservation' resource, or the 'null' value.", "x-one-of-name": "uuidpool.Reservation.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.Reservation" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.Reservation": { "title": "Uuidpool:Reservation", "description": "The UUID reservation object, used to hold reserved identity.", "x-allOf-name": "uuidpool.Reservation", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.Reservation" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.Reservation', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.Reservation" ], "default": "uuidpool.Reservation", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.Reservation" ], "default": "uuidpool.Reservation", "x-enum-as-string": true }, "Identity": { "description": "UUID identity to be reserved.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-createOnly": true, "x-omitempty": true }, "Block": { "$ref": "#/components/schemas/uuidpool.Block.Relationship", "description": "A reference to a uuidpoolBlock resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Pool": { "$ref": "#/components/schemas/uuidpool.Pool.Relationship", "description": "A reference to a uuidpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "PoolMember": { "$ref": "#/components/schemas/uuidpool.PoolMember.Relationship", "description": "A reference to a uuidpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/uuidpool.Universe.Relationship", "description": "A reference to a uuidpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "uuidpool.Reservation.List": { "title": "List of 'uuidpool.Reservation' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.Reservation' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.Reservation' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Reservation" }, "nullable": true } } } ] }, "uuidpool.ReservationReference": { "title": "Uuidpool:Reservation Reference", "description": "The reference to the reservation object.", "x-allOf-name": "uuidpool.ReservationReference", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.ReservationReference" } ] }, "uuidpool.Universe.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.Universe' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.Universe' resources.", "x-one-of-name": "uuidpool.Universe.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.Universe.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.Universe.Relationship": { "description": "A relationship to the 'uuidpool.Universe' resource, or the expanded 'uuidpool.Universe' resource, or the 'null' value.", "x-one-of-name": "uuidpool.Universe.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.Universe" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.Universe": { "title": "Uuidpool:Universe", "description": "Universe represents a book keeping container to keep track of all UUIDs for a given account.", "x-allOf-name": "uuidpool.Universe", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.Universe', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.Universe" ], "default": "uuidpool.Universe", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.Universe" ], "default": "uuidpool.Universe", "x-enum-as-string": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "uuidpool.Universe.List": { "title": "List of 'uuidpool.Universe' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.Universe' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.Universe' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.Universe" }, "nullable": true } } } ] }, "uuidpool.UuidBlock": { "title": "Uuidpool:Uuid Block", "description": "UUID suffix block representation.", "x-allOf-name": "uuidpool.UuidBlock", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractBlockType" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.UuidBlock', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.UuidBlock" ], "default": "uuidpool.UuidBlock", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.UuidBlock" ], "default": "uuidpool.UuidBlock", "x-enum-as-string": true }, "From": { "description": "Starting UUID suffix of the block must be in hexadecimal format xxxx-xxxxxxxxxxxx.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-omitempty": true }, "To": { "description": "Starting UUID suffix of the block must be in hexadecimal format xxxx-xxxxxxxxxxxx.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-omitempty": true } } } ] }, "uuidpool.UuidLease.Response": { "description": "The response body of a HTTP GET request for the 'uuidpool.UuidLease' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'uuidpool.UuidLease' resources.", "x-one-of-name": "uuidpool.UuidLease.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/uuidpool.UuidLease.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "uuidpool.UuidLease.Relationship": { "description": "A relationship to the 'uuidpool.UuidLease' resource, or the expanded 'uuidpool.UuidLease' resource, or the 'null' value.", "x-one-of-name": "uuidpool.UuidLease.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/uuidpool.UuidLease" } ], "discriminator": { "propertyName": "ClassId" } }, "uuidpool.UuidLease": { "title": "Uuidpool:Uuid Lease", "description": "UuidLease represents a single UUID that is part of the universe, allocated either from a pool or through static assignment.", "x-allOf-name": "uuidpool.UuidLease", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/pool.AbstractLease" }, { "type": "object", "description": "Definition of the list of properties defined in 'uuidpool.UuidLease', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "uuidpool.UuidLease" ], "default": "uuidpool.UuidLease", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "uuidpool.UuidLease" ], "default": "uuidpool.UuidLease", "x-enum-as-string": true }, "PreferredUuid": { "description": "The preferred UUID can be specified only for dynamic lease requests. Intersight will make its best effort to allocate that UUID if it is available in the pool. If the specified preferred UUID is not in the range of the pool or if it is already leased or reserved, then the next available UUID from the pool will be leased. Since this feature is specific to dynamic lease requests only, static lease request will fail if it specifies the preferred UUID property. When the preferred UUID property is specified in conjunction with 'migrate' property, existing static or dynamic lease will be replaced by the new lease. Migration also supported only for dynamic lease requests.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-createOnly": true, "x-omitempty": true }, "Reservation": { "description": "The holder of a reference to reservation Moid and the specific details on lease condition for this reservation. Specified to allocate already reserved identities.", "$ref": "#/components/schemas/uuidpool.ReservationReference", "x-createOnly": true, "x-omitempty": true }, "Uuid": { "description": "UUID Prefix+Suffix numbers.", "type": "string", "pattern": "^$|^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", "x-createOnly": true, "x-omitempty": true }, "AssignedToEntity": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Pool": { "$ref": "#/components/schemas/uuidpool.Pool.Relationship", "description": "A reference to a uuidpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PoolMember": { "$ref": "#/components/schemas/uuidpool.PoolMember.Relationship", "description": "A reference to a uuidpoolPoolMember resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Universe": { "$ref": "#/components/schemas/uuidpool.Universe.Relationship", "description": "A reference to a uuidpoolUniverse resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "uuidpool.UuidLease.List": { "title": "List of 'uuidpool.UuidLease' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'uuidpool.UuidLease' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'uuidpool.UuidLease' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/uuidpool.UuidLease" }, "nullable": true } } } ] }, "vmedia.Mapping": { "title": "Vmedia:Mapping", "description": "Virtual Media mapping settings required to map images from remote server.", "x-allOf-name": "vmedia.Mapping", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vmedia.Mapping', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vmedia.Mapping" ], "default": "vmedia.Mapping", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vmedia.Mapping" ], "default": "vmedia.Mapping", "x-enum-as-string": true }, "AuthenticationProtocol": { "description": "Type of Authentication protocol when CIFS is used for communication with the remote server.\n* `none` - No authentication is used.\n* `ntlm` - NT LAN Manager (NTLM) security protocol. Use this option only with Windows 2008 R2 and Windows 2012 R2.\n* `ntlmi` - NTLMi security protocol. Use this option only when you enable Digital Signing in the CIFS Windows server.\n* `ntlmv2` - NTLMv2 security protocol. Use this option only with Samba Linux.\n* `ntlmv2i` - NTLMv2i security protocol. Use this option only with Samba Linux.\n* `ntlmssp` - NT LAN Manager Security Support Provider (NTLMSSP) protocol. Use this option only with Windows 2008 R2 and Windows 2012 R2.\n* `ntlmsspi` - NTLMSSPi protocol. Use this option only when you enable Digital Signing in the CIFS Windows server.", "type": "string", "enum": [ "none", "ntlm", "ntlmi", "ntlmv2", "ntlmv2i", "ntlmssp", "ntlmsspi" ], "default": "none", "x-omitempty": true }, "DeviceType": { "description": "Type of remote Virtual Media device.\n* `cdd` - Uses compact disc drive as the virtual media mount device.\n* `hdd` - Uses hard disk drive as the virtual media mount device.", "type": "string", "enum": [ "cdd", "hdd" ], "default": "cdd", "x-omitempty": true }, "FileLocation": { "description": "Remote location of image. Preferred format is 'hostname/filePath/fileName'.", "type": "string", "x-omitempty": true }, "HostName": { "description": "IP address or hostname of the remote server.", "type": "string", "x-omitempty": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "MountOptions": { "description": "Mount options for the Virtual Media mapping. The field can be left blank or filled in a comma separated list with the following options.\\n For NFS, supported options are ro, rw, nolock, noexec, soft, port=VALUE, timeo=VALUE, retry=VALUE.\\n For CIFS, supported options are soft, nounix, noserverino, guest.\\n For CIFS version < 3.0, vers=VALUE is mandatory. e.g. vers=2.0\\n For HTTP/HTTPS, the only supported option is noauto.", "type": "string", "minLength": 0, "maxLength": 248, "x-omitempty": true }, "MountProtocol": { "description": "Protocol to use to communicate with the remote server.\n* `nfs` - NFS protocol for vmedia mount.\n* `cifs` - CIFS protocol for vmedia mount.\n* `http` - HTTP protocol for vmedia mount.\n* `https` - HTTPS protocol for vmedia mount.", "type": "string", "enum": [ "nfs", "cifs", "http", "https" ], "default": "nfs", "x-omitempty": true }, "Password": { "description": "Password associated with the username.", "type": "string", "minLength": 0, "maxLength": 255, "writeOnly": true, "x-omitempty": true }, "RemoteFile": { "description": "The remote file location path for the virtual media mapping. Accepted formats are:\nHDD for CIFS/NFS: hostname-or-IP/filePath/fileName.img.\nCDD for CIFS/NFS: hostname-or-IP/filePath/fileName.iso.\nHDD for HTTP/S: http[s]://hostname-or-IP/filePath/fileName.img.\nCDD for HTTP/S: http[s]://hostname-or-IP/filePath/fileName.iso.", "type": "string", "pattern": "^$|^[ !#$%\\(\\)\\+,\\-\\.:\\?@\\[\\]_\\{\\}=~a-zA-Z0-9]+$", "minLength": 0, "maxLength": 235, "x-omitempty": true }, "RemotePath": { "description": "URL path to the location of the image on the remote server. The preferred format is '/path'.", "type": "string", "pattern": "^$|^[ !#$%\\(\\)\\+,\\-\\.\\/:\\?@\\[\\]_\\{\\}=~a-zA-Z0-9]+$", "x-omitempty": true }, "SanitizedFileLocation": { "description": "File Location in standard format 'hostname/filePath/fileName'. This field should be used to calculate config drift. User input format may vary while inventory will return data in format in compliance with mount option for the mount. Both will be converged to this standard format for comparison.", "type": "string", "readOnly": true, "x-omitempty": true }, "Username": { "description": "Username to log in to the remote server.", "type": "string", "minLength": 0, "maxLength": 255, "x-omitempty": true }, "VolumeName": { "description": "Identity of the image for Virtual Media mapping.", "type": "string", "pattern": "^[\\-\\.:_a-zA-Z0-9]+$", "minLength": 1, "maxLength": 47, "x-omitempty": true } } } ] }, "vmedia.Policy.Response": { "description": "The response body of a HTTP GET request for the 'vmedia.Policy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vmedia.Policy' resources.", "x-one-of-name": "vmedia.Policy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vmedia.Policy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vmedia.Policy": { "title": "Virtual Media", "description": "The Virtual Media Policy is a reusable policy that configures the virtual media service on a server's management controller, allowing for the remote mounting of software images.\n#### Purpose\nThe purpose of this policy is to enable and standardize the use of virtual media, which is essential for tasks like remote operating system installation, running diagnostic tools, or booting from recovery images. The policy defines how the virtual media service operates and specifies the remote locations of the images to be mounted.\n#### Key Concepts\n- **Remote Image Mounting:** The core function is to create mappings to remote image files (ISO or IMG), making them appear as local CD/DVD or HDD drives to the server.\n- **Multiple Protocol Support:** It supports mounting images from remote servers using various protocols, including NFS, CIFS, HTTP, and HTTPS.\n- **Service Control:** The policy allows administrators to enable or disable the virtual media service and to enforce encryption for all virtual media communications.\n- **Profile-Based Application:** It is attached to a Server Profile to apply a consistent virtual media configuration and set of mappings to multiple servers.\n- **Authentication:** For protocols like CIFS, the policy securely stores the username and password required to access the remote file share.", "x-allOf-name": "vmedia.Policy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vmedia.Policy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vmedia.Policy" ], "default": "vmedia.Policy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vmedia.Policy" ], "default": "vmedia.Policy", "x-enum-as-string": true }, "Enabled": { "description": "State of the Virtual Media service on the endpoint.", "type": "boolean", "default": true, "x-omitempty": true }, "Encryption": { "description": "If enabled, allows encryption of all Virtual Media communications. Please note that this can no longer be disabled for servers running versions 4.2 and above.", "type": "boolean", "default": true, "x-omitempty": true }, "LowPowerUsb": { "description": "If enabled, the virtual drives appear on the boot selection menu after mapping the image and rebooting the host.", "type": "boolean", "default": true, "x-omitempty": true }, "Mappings": { "type": "array", "items": { "description": "Adds a new Virtual Media mapping for images.", "$ref": "#/components/schemas/vmedia.Mapping", "x-omitempty": true }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "vmedia.Policy.List": { "title": "List of 'vmedia.Policy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vmedia.Policy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vmedia.Policy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vmedia.Policy" }, "nullable": true } } } ] }, "vmedia.PolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vmedia.PolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vmedia.PolicyInventory' resources.", "x-one-of-name": "vmedia.PolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vmedia.PolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vmedia.PolicyInventory": { "title": "Virtual Media", "description": "The Virtual Media Policy is a reusable policy that configures the virtual media service on a server's management controller, allowing for the remote mounting of software images.\n#### Purpose\nThe purpose of this policy is to enable and standardize the use of virtual media, which is essential for tasks like remote operating system installation, running diagnostic tools, or booting from recovery images. The policy defines how the virtual media service operates and specifies the remote locations of the images to be mounted.\n#### Key Concepts\n- **Remote Image Mounting:** The core function is to create mappings to remote image files (ISO or IMG), making them appear as local CD/DVD or HDD drives to the server.\n- **Multiple Protocol Support:** It supports mounting images from remote servers using various protocols, including NFS, CIFS, HTTP, and HTTPS.\n- **Service Control:** The policy allows administrators to enable or disable the virtual media service and to enforce encryption for all virtual media communications.\n- **Profile-Based Application:** It is attached to a Server Profile to apply a consistent virtual media configuration and set of mappings to multiple servers.\n- **Authentication:** For protocols like CIFS, the policy securely stores the username and password required to access the remote file share.", "x-allOf-name": "vmedia.PolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vmedia.PolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vmedia.PolicyInventory" ], "default": "vmedia.PolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vmedia.PolicyInventory" ], "default": "vmedia.PolicyInventory", "x-enum-as-string": true }, "Enabled": { "description": "State of the Virtual Media service on the endpoint.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Encryption": { "description": "If enabled, allows encryption of all Virtual Media communications. Please note that this can no longer be disabled for servers running versions 4.2 and above.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "LowPowerUsb": { "description": "If enabled, the virtual drives appear on the boot selection menu after mapping the image and rebooting the host.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "Mappings": { "type": "array", "items": { "description": "Adds a new Virtual Media mapping for images.", "$ref": "#/components/schemas/vmedia.Mapping", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vmedia.PolicyInventory.List": { "title": "List of 'vmedia.PolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vmedia.PolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vmedia.PolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vmedia.PolicyInventory" }, "nullable": true } } } ] }, "vnic.ArfsSettings": { "title": "ARFS Settings", "description": "Settings for Accelerated Receive Flow Steering to reduce the network latency and increase CPU cache efficiency.", "x-allOf-name": "vnic.ArfsSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.ArfsSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.ArfsSettings" ], "default": "vnic.ArfsSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.ArfsSettings" ], "default": "vnic.ArfsSettings", "x-enum-as-string": true }, "Enabled": { "description": "Status of Accelerated Receive Flow Steering on the virtual ethernet interface.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "vnic.BaseEthIf": { "title": "Vnic", "description": "A Vnic specifying configuration settings.", "x-allOf-name": "vnic.BaseEthIf", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyItem" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.BaseEthIf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "vnic.EthIf", "vnic.VnicTemplate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "vnic.EthIf", "vnic.VnicTemplate" ], "x-enum-as-string": true }, "Cdn": { "description": "Consistent Device Naming configuration for the virtual NIC.", "$ref": "#/components/schemas/vnic.Cdn", "x-omitempty": true }, "FailoverEnabled": { "description": "Enabling failover ensures that traffic from the vNIC automatically fails over to the secondary Fabric Interconnect, in case the specified Fabric Interconnect path goes down. Failover applies only to Cisco VICs that are connected to a Fabric Interconnect cluster.", "type": "boolean", "default": false, "x-omitempty": true }, "PinGroupName": { "description": "Pingroup name associated to vNIC for static pinning. LCP deploy will resolve pingroup name and fetches the correspoding uplink port/port channel to pin the vNIC traffic.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "SriovSettings": { "description": "Single Root Input Output Virtualization (SR-IOV) Settings that enable one physical ethernet socket to appear as multiple NICs to the hypervisor.", "$ref": "#/components/schemas/vnic.SriovSettings", "x-omitempty": true }, "UsnicSettings": { "description": "User Space NIC Settings that enable low-latency and higher throughput by bypassing the kernel layer when sending/receiving packets.", "$ref": "#/components/schemas/vnic.UsnicSettings", "x-omitempty": true }, "VmqSettings": { "description": "Virtual Machine Queue Settings for the virtual interface that allow efficient transfer of network traffic to the guest OS.", "$ref": "#/components/schemas/vnic.VmqSettings", "x-omitempty": true }, "EthAdapterPolicy": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy.Relationship", "description": "A reference to a vnicEthAdapterPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EthNetworkPolicy": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy.Relationship", "description": "A reference to a vnicEthNetworkPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "EthQosPolicy": { "$ref": "#/components/schemas/vnic.EthQosPolicy.Relationship", "description": "A reference to a vnicEthQosPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FabricEthNetworkControlPolicy": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.EthNetworkControlPolicy.Relationship", "description": "A reference to a fabricEthNetworkControlPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FabricEthNetworkGroupPolicy": { "description": "An array of relationships to fabricEthNetworkGroupPolicy resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.EthNetworkGroupPolicy.Relationship" }, "nullable": true }, "IscsiBootPolicy": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy.Relationship", "description": "A reference to a vnicIscsiBootPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "MacPool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.BaseFcIf": { "title": "Vhba", "description": "A Vhba specifying configuration settings.", "x-allOf-name": "vnic.BaseFcIf", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyItem" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.BaseFcIf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "vnic.FcIf", "vnic.VhbaTemplate" ], "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.\nThe enum values provides the list of concrete types that can be instantiated from this abstract type.", "enum": [ "vnic.FcIf", "vnic.VhbaTemplate" ], "x-enum-as-string": true }, "PersistentBindings": { "description": "Enables retention of LUN ID associations in memory until they are manually cleared.", "type": "boolean", "x-omitempty": true }, "PinGroupName": { "description": "Pingroup name associated to vfc for static pinning. SCP deploy will resolve pingroup name and fetches the correspoding uplink port/port channel to pin the vfc traffic.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true }, "Type": { "description": "VHBA Type configuration for SAN Connectivity Policy. This configuration is supported only on Cisco VIC 14XX series and higher series of adapters.\n* `fc-initiator` - The default value set for vHBA Type Configuration. Fc-initiator specifies vHBA as a consumer of storage. Enables SCSI commands to transfer data and status information between host and target storage systems.\n* `fc-nvme-initiator` - Fc-nvme-initiator specifies vHBA as a consumer of storage. Enables NVMe-based message commands to transfer data and status information between host and target storage systems.\n* `fc-nvme-target` - Fc-nvme-target specifies vHBA as a provider of storage volumes to initiators. Enables NVMe-based message commands to transfer data and status information between host and target storage systems. Currently tech-preview, only enabled with an asynchronous driver.\n* `fc-target` - Fc-target specifies vHBA as a provider of storage volumes to initiators. Enables SCSI commands to transfer data and status information between host and target storage systems. fc-target is enabled only with an asynchronous driver.", "type": "string", "enum": [ "fc-initiator", "fc-nvme-initiator", "fc-nvme-target", "fc-target" ], "default": "fc-initiator", "x-omitempty": true }, "FcAdapterPolicy": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy.Relationship", "description": "A reference to a vnicFcAdapterPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FcNetworkPolicy": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy.Relationship", "description": "A reference to a vnicFcNetworkPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FcQosPolicy": { "$ref": "#/components/schemas/vnic.FcQosPolicy.Relationship", "description": "A reference to a vnicFcQosPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "FcZonePolicies": { "description": "An array of relationships to fabricFcZonePolicy resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.FcZonePolicy.Relationship" }, "nullable": true }, "WwpnPool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.Cdn": { "title": "Consistent Device Naming", "description": "Consistent Device Naming configuration for the virtual NIC.", "x-allOf-name": "vnic.Cdn", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.Cdn', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.Cdn" ], "default": "vnic.Cdn", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.Cdn" ], "default": "vnic.Cdn", "x-enum-as-string": true }, "Source": { "description": "Source of the CDN. It can either be user specified or be the same as the vNIC name.\n* `vnic` - Source of the CDN is the same as the vNIC name.\n* `user` - Source of the CDN is specified by the user.", "type": "string", "enum": [ "vnic", "user" ], "default": "vnic", "x-omitempty": true }, "Value": { "description": "The CDN value entered in case of user defined mode.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\._:]*$", "maxLength": 31, "x-omitempty": true } } } ] }, "vnic.CompletionQueueSettings": { "title": "Completion Queue Settings", "description": "Completion Queue resource settings.", "x-allOf-name": "vnic.CompletionQueueSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.CompletionQueueSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.CompletionQueueSettings" ], "default": "vnic.CompletionQueueSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.CompletionQueueSettings" ], "default": "vnic.CompletionQueueSettings", "x-enum-as-string": true }, "Count": { "description": "The number of completion queue resources to allocate. In general, the number of completion queue resources to allocate is equal to the number of transmit queue resources plus the number of receive queue resources.", "type": "integer", "format": "int64", "default": 5, "minimum": 1, "maximum": 2000, "x-omitempty": true }, "RingSize": { "description": "The number of descriptors in each completion queue.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 256, "x-omitempty": true } } } ] }, "vnic.EthAdapterPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthAdapterPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthAdapterPolicy' resources.", "x-one-of-name": "vnic.EthAdapterPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthAdapterPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthAdapterPolicy.Relationship": { "description": "A relationship to the 'vnic.EthAdapterPolicy' resource, or the expanded 'vnic.EthAdapterPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.EthAdapterPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthAdapterPolicy": { "title": "Ethernet Adapter", "description": "The EthAdapterPolicy object governs the behavior of Ethernet adapters, focusing on host-side features such as offloads, virtualization support, and advanced network functions.\n#### Purpose\nEthAdapterPolicy allows administrators to control the detailed functionality of network adapters, including enabling or disabling features like VXLAN, SR-IOV, and interrupt handling for performance tuning.\n#### Key Concepts\n- **Host-Side Feature Management:** Configures advanced adapter features for improved efficiency and performance.\n- **Comprehensive Control:** Supports settings for offloads, virtualization, and queue management.", "x-allOf-name": "vnic.EthAdapterPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthAdapterPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthAdapterPolicy" ], "default": "vnic.EthAdapterPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthAdapterPolicy" ], "default": "vnic.EthAdapterPolicy", "x-enum-as-string": true }, "AdvancedFilter": { "description": "Enables advanced filtering on the interface.", "type": "boolean", "default": false, "x-omitempty": true }, "ArfsSettings": { "description": "Settings for Accelerated Receive Flow Steering to reduce the network latency and increase CPU cache efficiency.", "$ref": "#/components/schemas/vnic.ArfsSettings", "x-omitempty": true }, "CompletionQueueSettings": { "description": "Completion Queue resource settings.", "$ref": "#/components/schemas/vnic.CompletionQueueSettings", "x-omitempty": true }, "EtherChannelPinningEnabled": { "description": "Enables EtherChannel Pinning to combine multiple physical links between two network switches into a single logical link. Transmit Queue Count should be at least 2 to enable ether channel pinning.", "type": "boolean", "default": false, "x-omitempty": true }, "GeneveEnabled": { "description": "GENEVE offload protocol allows you to create logical networks that span physical network boundaries by allowing any information to be encoded in a packet and passed between tunnel endpoints.", "type": "boolean", "default": false, "x-omitempty": true }, "InterruptScaling": { "description": "Enables Interrupt Scaling on the interface.", "type": "boolean", "default": false, "x-omitempty": true }, "InterruptSettings": { "description": "Interrupt Settings for the virtual ethernet interface.", "$ref": "#/components/schemas/vnic.EthInterruptSettings", "x-omitempty": true }, "NvgreSettings": { "description": "Network Virtualization using Generic Routing Encapsulation Settings.", "$ref": "#/components/schemas/vnic.NvgreSettings", "x-omitempty": true }, "PtpSettings": { "description": "Settings for Precision Time Protocol which can provide precise time of day information and time-stampted inputs, as well as scheduled and/or synchronized outputs for a variety of systems.", "$ref": "#/components/schemas/vnic.PtpSettings", "x-omitempty": true }, "RoceSettings": { "description": "Settings for RDMA over Converged Ethernet.", "$ref": "#/components/schemas/vnic.RoceSettings", "x-omitempty": true }, "RssHashSettings": { "description": "Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores.", "$ref": "#/components/schemas/vnic.RssHashSettings", "x-omitempty": true }, "RssSettings": { "description": "Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores.", "type": "boolean", "default": true, "x-omitempty": true }, "RxQueueSettings": { "description": "Receive Queue resouce settings.", "$ref": "#/components/schemas/vnic.EthRxQueueSettings", "x-omitempty": true }, "TcpOffloadSettings": { "description": "The TCP offload settings decide whether to offload the TCP related network functions from the CPU to the network hardware or not.", "$ref": "#/components/schemas/vnic.TcpOffloadSettings", "x-omitempty": true }, "TxQueueSettings": { "description": "Transmit Queue resource settings.", "$ref": "#/components/schemas/vnic.EthTxQueueSettings", "x-omitempty": true }, "UplinkFailbackTimeout": { "description": "Uplink Failback Timeout in seconds when uplink failover is enabled for a vNIC. After a vNIC has started using its secondary interface, this setting controls how long the primary interface must be available before the system resumes using the primary interface for the vNIC.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 600, "x-omitempty": true }, "VxlanSettings": { "description": "Virtual Extensible LAN Protocol Settings.", "$ref": "#/components/schemas/vnic.VxlanSettings", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.EthAdapterPolicy.List": { "title": "List of 'vnic.EthAdapterPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthAdapterPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthAdapterPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthAdapterPolicy" }, "nullable": true } } } ] }, "vnic.EthAdapterPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthAdapterPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthAdapterPolicyInventory' resources.", "x-one-of-name": "vnic.EthAdapterPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthAdapterPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.EthAdapterPolicyInventory' resource, or the expanded 'vnic.EthAdapterPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.EthAdapterPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthAdapterPolicyInventory": { "title": "Ethernet Adapter", "description": "The EthAdapterPolicy object governs the behavior of Ethernet adapters, focusing on host-side features such as offloads, virtualization support, and advanced network functions.\n#### Purpose\nEthAdapterPolicy allows administrators to control the detailed functionality of network adapters, including enabling or disabling features like VXLAN, SR-IOV, and interrupt handling for performance tuning.\n#### Key Concepts\n- **Host-Side Feature Management:** Configures advanced adapter features for improved efficiency and performance.\n- **Comprehensive Control:** Supports settings for offloads, virtualization, and queue management.", "x-allOf-name": "vnic.EthAdapterPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthAdapterPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthAdapterPolicyInventory" ], "default": "vnic.EthAdapterPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthAdapterPolicyInventory" ], "default": "vnic.EthAdapterPolicyInventory", "x-enum-as-string": true }, "AdvancedFilter": { "description": "Enables advanced filtering on the interface.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "ArfsSettings": { "description": "Settings for Accelerated Receive Flow Steering to reduce the network latency and increase CPU cache efficiency.", "$ref": "#/components/schemas/vnic.ArfsSettings", "readOnly": true, "x-omitempty": true }, "CompletionQueueSettings": { "description": "Completion Queue resource settings.", "$ref": "#/components/schemas/vnic.CompletionQueueSettings", "readOnly": true, "x-omitempty": true }, "EtherChannelPinningEnabled": { "description": "Enables EtherChannel Pinning to combine multiple physical links between two network switches into a single logical link. Transmit Queue Count should be at least 2 to enable ether channel pinning.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "GeneveEnabled": { "description": "GENEVE offload protocol allows you to create logical networks that span physical network boundaries by allowing any information to be encoded in a packet and passed between tunnel endpoints.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "InterruptScaling": { "description": "Enables Interrupt Scaling on the interface.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "InterruptSettings": { "description": "Interrupt Settings for the virtual ethernet interface.", "$ref": "#/components/schemas/vnic.EthInterruptSettings", "readOnly": true, "x-omitempty": true }, "NvgreSettings": { "description": "Network Virtualization using Generic Routing Encapsulation Settings.", "$ref": "#/components/schemas/vnic.NvgreSettings", "readOnly": true, "x-omitempty": true }, "PtpSettings": { "description": "Settings for Precision Time Protocol which can provide precise time of day information and time-stampted inputs, as well as scheduled and/or synchronized outputs for a variety of systems.", "$ref": "#/components/schemas/vnic.PtpSettings", "readOnly": true, "x-omitempty": true }, "RoceSettings": { "description": "Settings for RDMA over Converged Ethernet.", "$ref": "#/components/schemas/vnic.RoceSettings", "readOnly": true, "x-omitempty": true }, "RssHashSettings": { "description": "Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores.", "$ref": "#/components/schemas/vnic.RssHashSettings", "readOnly": true, "x-omitempty": true }, "RssSettings": { "description": "Receive Side Scaling allows the incoming traffic to be spread across multiple CPU cores.", "type": "boolean", "default": true, "readOnly": true, "x-omitempty": true }, "RxQueueSettings": { "description": "Receive Queue resouce settings.", "$ref": "#/components/schemas/vnic.EthRxQueueSettings", "readOnly": true, "x-omitempty": true }, "TcpOffloadSettings": { "description": "The TCP offload settings decide whether to offload the TCP related network functions from the CPU to the network hardware or not.", "$ref": "#/components/schemas/vnic.TcpOffloadSettings", "readOnly": true, "x-omitempty": true }, "TxQueueSettings": { "description": "Transmit Queue resource settings.", "$ref": "#/components/schemas/vnic.EthTxQueueSettings", "readOnly": true, "x-omitempty": true }, "UplinkFailbackTimeout": { "description": "Uplink Failback Timeout in seconds when uplink failover is enabled for a vNIC. After a vNIC has started using its secondary interface, this setting controls how long the primary interface must be available before the system resumes using the primary interface for the vNIC.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 600, "readOnly": true, "x-omitempty": true }, "VxlanSettings": { "description": "Virtual Extensible LAN Protocol Settings.", "$ref": "#/components/schemas/vnic.VxlanSettings", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthAdapterPolicyInventory.List": { "title": "List of 'vnic.EthAdapterPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthAdapterPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthAdapterPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory" }, "nullable": true } } } ] }, "vnic.EthIf.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthIf' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthIf' resources.", "x-one-of-name": "vnic.EthIf.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthIf.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthIf.Relationship": { "description": "A relationship to the 'vnic.EthIf' resource, or the expanded 'vnic.EthIf' resource, or the 'null' value.", "x-one-of-name": "vnic.EthIf.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthIf" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthIf": { "title": "Virtual Ethernet Interface", "description": "The EthIf object represents a virtual Ethernet interface (vNIC) within Cisco\u2019s infrastructure. It serves as an abstraction of a network interface presented to the operating system, managed through higher-level policies.\n#### Purpose\nEthIf enables detailed configuration of virtual Ethernet connectivity for servers, including placement, MAC address assignment, and association with policies governing network behavior and quality of service.\n#### Key Concepts\n- **Abstraction of Network Interfaces:** Provides a virtualized representation of Ethernet interfaces on server hardware.\n- **Policy Attachment:** Integrates with various policies (network, QoS, adapter) for unified control.\n- **Template Support:** Can be instantiated from templates, supporting both inheritance and overrides for flexibility.\n- **Failover and Redundancy:** Supports features like failover for high availability in fabric-attached environments.", "x-allOf-name": "vnic.EthIf", "allOf": [ { "$ref": "#/components/schemas/vnic.BaseEthIf" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthIf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthIf" ], "default": "vnic.EthIf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthIf" ], "default": "vnic.EthIf", "x-enum-as-string": true }, "IscsiIpV4AddressAllocationType": { "description": "Static/Pool/DHCP Type of IP address allocated to the vNIC. It is derived from iSCSI boot policy IP Address type.\n* `None` - Type indicates that there is no IP associated to an vnic.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "None", "DHCP", "Static", "Pool" ], "default": "None", "readOnly": true, "x-omitempty": true }, "IscsiIpV4Config": { "description": "IPV4 configurations such as Netmask, Gateway and DNS for iSCSI vNIC.", "$ref": "#/components/schemas/ippool.IpV4Config", "readOnly": true, "x-omitempty": true }, "IscsiIpV6AddressAllocationType": { "description": "Static/Pool/DHCP Type of IPv6 address allocated to the vNIC. It is derived from iSCSI boot policy IP Address type.\n* `None` - Type indicates that there is no IP associated to an vnic.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "None", "DHCP", "Static", "Pool" ], "default": "None", "readOnly": true, "x-omitempty": true }, "IscsiIpV6Config": { "description": "IPv6 configurations such as Prefix, Gateway and DNS for iSCSI vNIC.", "$ref": "#/components/schemas/ippool.IpV6Config", "readOnly": true, "x-omitempty": true }, "IscsiIpv4Address": { "description": "IP address associated to the vNIC.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "IscsiIpv6Address": { "description": "IPv6 address associated to the iSCSI vNIC.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "The MAC address that is assigned to the vNIC based on the MAC pool that has been assigned to the LAN Connectivity Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddressType": { "description": "Type of allocation selected to assign a MAC address for the vnic.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "x-omitempty": true }, "Name": { "description": "Name of the virtual ethernet interface.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "x-omitempty": true }, "NetFlowMonitorSessions": { "type": "array", "items": { "description": "NetFlow Monitor on Vethernet, Maximum NetFlow monitors per veth are two.", "$ref": "#/components/schemas/vnic.NetFlowMonitorSession", "x-omitempty": true }, "nullable": true }, "OldInfo": { "description": "Deployed information related to lease and vif id.", "$ref": "#/components/schemas/vnic.EthIfOldInfo", "readOnly": true, "x-omitempty": true }, "Order": { "description": "The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The order should start from zero with no overlaps. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1340, VIC 1380 and VIC 1385 which have two.", "type": "integer", "format": "int64", "minimum": 0, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "x-omitempty": true }, "Stale": { "description": "An EthIf is marked stale if it was deployed to the endpoint and the LAN Connectivity Policy associated with the server profile does not have this EthIf anymore. This maybe due to the LAN Connectivity Policy being removed from the server profile or a different LAN Connectivity Policy is attached which does not include any EthIf with the same name.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StandbyVifId": { "description": "The Standby VIF Id is applicable for failover enabled vNICS. It should be the same as the channel number of the standby vethernet created on switch in order to set up the standby data path.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StaticMacAddress": { "description": "The MAC address must be in hexadecimal format xx:xx:xx:xx:xx:xx.\nTo ensure uniqueness of MACs in the LAN fabric, you are strongly encouraged to use the\nfollowing MAC prefix 00:25:B5:xx:xx:xx.", "type": "string", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "The Vif Id should be same as the channel number of the vethernet created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vethernet is created on the switch for every vNIC.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "IpLease": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LanConnectivityPolicy": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy.Relationship", "description": "A reference to a vnicLanConnectivityPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "LcpVnic": { "$ref": "#/components/schemas/vnic.EthIf.Relationship", "description": "A reference to a vnicEthIf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MacLease": { "$ref": "#/components/schemas/macpool.Lease.Relationship", "description": "A reference to a macpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "SpVnics": { "description": "An array of relationships to vnicEthIf resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIf.Relationship" }, "nullable": true, "readOnly": true }, "SrcTemplate": { "$ref": "#/components/schemas/vnic.VnicTemplate.Relationship", "description": "A reference to a vnicVnicTemplate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.EthIf.List": { "title": "List of 'vnic.EthIf' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthIf' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthIf' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIf" }, "nullable": true } } } ] }, "vnic.EthIfInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthIfInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthIfInventory' resources.", "x-one-of-name": "vnic.EthIfInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthIfInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthIfInventory.Relationship": { "description": "A relationship to the 'vnic.EthIfInventory' resource, or the expanded 'vnic.EthIfInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.EthIfInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthIfInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthIfInventory": { "title": "Virtual Ethernet Interface", "description": "The EthIf object represents a virtual Ethernet interface (vNIC) within Cisco\u2019s infrastructure. It serves as an abstraction of a network interface presented to the operating system, managed through higher-level policies.\n#### Purpose\nEthIf enables detailed configuration of virtual Ethernet connectivity for servers, including placement, MAC address assignment, and association with policies governing network behavior and quality of service.\n#### Key Concepts\n- **Abstraction of Network Interfaces:** Provides a virtualized representation of Ethernet interfaces on server hardware.\n- **Policy Attachment:** Integrates with various policies (network, QoS, adapter) for unified control.\n- **Template Support:** Can be instantiated from templates, supporting both inheritance and overrides for flexibility.\n- **Failover and Redundancy:** Supports features like failover for high availability in fabric-attached environments.", "x-allOf-name": "vnic.EthIfInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthIfInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthIfInventory" ], "default": "vnic.EthIfInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthIfInventory" ], "default": "vnic.EthIfInventory", "x-enum-as-string": true }, "Cdn": { "description": "Consistent Device Naming configuration for the virtual NIC.", "$ref": "#/components/schemas/vnic.Cdn", "readOnly": true, "x-omitempty": true }, "FailoverEnabled": { "description": "Enabling failover ensures that traffic from the vNIC automatically fails over to the secondary Fabric Interconnect, in case the specified Fabric Interconnect path goes down. Failover applies only to Cisco VICs that are connected to a Fabric Interconnect cluster.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IscsiIpV4AddressAllocationType": { "description": "Static/Pool/DHCP Type of IP address allocated to the vNIC. It is derived from iSCSI boot policy IP Address type.\n* `None` - Type indicates that there is no IP associated to an vnic.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "None", "DHCP", "Static", "Pool" ], "default": "None", "readOnly": true, "x-omitempty": true }, "IscsiIpV4Config": { "description": "IPV4 configurations such as Netmask, Gateway and DNS for iSCSI vNIC.", "$ref": "#/components/schemas/ippool.IpV4Config", "readOnly": true, "x-omitempty": true }, "IscsiIpV6AddressAllocationType": { "description": "Static/Pool/DHCP Type of IPv6 address allocated to the vNIC. It is derived from iSCSI boot policy IP Address type.\n* `None` - Type indicates that there is no IP associated to an vnic.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "None", "DHCP", "Static", "Pool" ], "default": "None", "readOnly": true, "x-omitempty": true }, "IscsiIpV6Config": { "description": "IPv6 configurations such as Prefix, Gateway and DNS for iSCSI vNIC.", "$ref": "#/components/schemas/ippool.IpV6Config", "readOnly": true, "x-omitempty": true }, "IscsiIpv4Address": { "description": "IP address associated to the vNIC.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "IscsiIpv6Address": { "description": "IPv6 address associated to the iSCSI vNIC.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "MacAddress": { "description": "The MAC address that is assigned to the vNIC based on the MAC pool that has been assigned to the LAN Connectivity Policy.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddressType": { "description": "Type of allocation selected to assign a MAC address for the vnic.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the virtual ethernet interface.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "readOnly": true, "x-omitempty": true }, "NetFlowMonitorSessions": { "type": "array", "items": { "description": "NetFlow Monitor on Vethernet, Maximum NetFlow monitors per veth are two.", "$ref": "#/components/schemas/vnic.NetFlowMonitorSession", "readOnly": true, "x-omitempty": true }, "nullable": true }, "OldInfo": { "description": "Deployed information related to lease and vif id.", "$ref": "#/components/schemas/vnic.EthIfOldInfo", "readOnly": true, "x-omitempty": true }, "Order": { "description": "The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The order should start from zero with no overlaps. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1340, VIC 1380 and VIC 1385 which have two.", "type": "integer", "format": "int64", "minimum": 0, "readOnly": true, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PinGroupName": { "description": "Pingroup name associated to vNIC for static pinning. LCP deploy will resolve pingroup name and fetches the correspoding uplink port/port channel to pin the vNIC traffic.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.:-]{1,64}$", "readOnly": true, "x-omitempty": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "readOnly": true, "x-omitempty": true }, "SriovSettings": { "description": "Single Root Input Output Virtualization (SR-IOV) Settings that enable one physical ethernet socket to appear as multiple NICs to the hypervisor.", "$ref": "#/components/schemas/vnic.SriovSettings", "readOnly": true, "x-omitempty": true }, "Stale": { "description": "An EthIf is marked stale if it was deployed to the endpoint and the LAN Connectivity Policy associated with the server profile does not have this EthIf anymore. This maybe due to the LAN Connectivity Policy being removed from the server profile or a different LAN Connectivity Policy is attached which does not include any EthIf with the same name.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StandbyVifId": { "description": "The Standby VIF Id is applicable for failover enabled vNICS. It should be the same as the channel number of the standby vethernet created on switch in order to set up the standby data path.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StaticMacAddress": { "description": "The MAC address must be in hexadecimal format xx:xx:xx:xx:xx:xx.\nTo ensure uniqueness of MACs in the LAN fabric, you are strongly encouraged to use the\nfollowing MAC prefix 00:25:B5:xx:xx:xx.", "type": "string", "readOnly": true, "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "UsnicSettings": { "description": "User Space NIC Settings that enable low-latency and higher throughput by bypassing the kernel layer when sending/receiving packets.", "$ref": "#/components/schemas/vnic.UsnicSettings", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "The Vif Id should be same as the channel number of the vethernet created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vethernet is created on the switch for every vNIC.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "VmqSettings": { "description": "Virtual Machine Queue Settings for the virtual interface that allow efficient transfer of network traffic to the guest OS.", "$ref": "#/components/schemas/vnic.VmqSettings", "readOnly": true, "x-omitempty": true }, "EthAdapterPolicy": { "$ref": "#/components/schemas/vnic.EthAdapterPolicyInventory.Relationship", "description": "A reference to a vnicEthAdapterPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EthNetworkPolicy": { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory.Relationship", "description": "A reference to a vnicEthNetworkPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "EthQosPolicy": { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory.Relationship", "description": "A reference to a vnicEthQosPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FabricEthNetworkControlPolicy": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.EthNetworkControlPolicyInventory.Relationship", "description": "A reference to a fabricEthNetworkControlPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FabricEthNetworkGroupPolicy": { "description": "An array of relationships to fabricEthNetworkGroupPolicyInventory resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.EthNetworkGroupPolicyInventory.Relationship" }, "nullable": true, "readOnly": true }, "IpLease": { "$ref": "#/components/schemas/ippool.IpLease.Relationship", "description": "A reference to a ippoolIpLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IscsiBootPolicy": { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory.Relationship", "description": "A reference to a vnicIscsiBootPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LanConnectivityPolicy": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory.Relationship", "description": "A reference to a vnicLanConnectivityPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "LcpVnic": { "$ref": "#/components/schemas/vnic.EthIfInventory.Relationship", "description": "A reference to a vnicEthIfInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MacLease": { "$ref": "#/components/schemas/macpool.Lease.Relationship", "description": "A reference to a macpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "MacPool": { "$ref": "#/components/schemas/macpool.Pool.Relationship", "description": "A reference to a macpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SpVnics": { "description": "An array of relationships to vnicEthIfInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIfInventory.Relationship" }, "nullable": true, "readOnly": true }, "SrcTemplate": { "$ref": "#/components/schemas/vnic.VnicTemplate.Relationship", "description": "A reference to a vnicVnicTemplate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthIfInventory.List": { "title": "List of 'vnic.EthIfInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthIfInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthIfInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIfInventory" }, "nullable": true } } } ] }, "vnic.EthIfOldInfo": { "title": "EthIf Old Deployed Info", "description": "Deployed information related to lease and vif id.", "x-allOf-name": "vnic.EthIfOldInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthIfOldInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthIfOldInfo" ], "default": "vnic.EthIfOldInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthIfOldInfo" ], "default": "vnic.EthIfOldInfo", "x-enum-as-string": true }, "MacAddress": { "description": "Old MAC Address associated with the interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "MacAddressType": { "description": "Type of allocation selected to assign a MAC address for the vnic.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "MacLease": { "description": "Mac Address Lease taken for the vnic configured in the Lan Connectivity Policy.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "MacPool": { "description": "Mac Address Pool configured in the Lan Connectivity Policy.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "StandbyVifId": { "description": "Old Standby Vif id that was associated with the interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "StaticMacAddress": { "description": "The MAC address must be in hexadecimal format xx:xx:xx:xx:xx:xx.\nTo ensure uniqueness of MACs in the LAN fabric, you are strongly encouraged to use the\nfollowing MAC prefix 00:25:B5:xx:xx:xx.", "type": "string", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "Old Vif id that was associated with the interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "vnic.EthInterruptSettings": { "title": "Interrupt Settings", "description": "Interrupt settings for the virtual ethernet interface.", "x-allOf-name": "vnic.EthInterruptSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthInterruptSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthInterruptSettings" ], "default": "vnic.EthInterruptSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthInterruptSettings" ], "default": "vnic.EthInterruptSettings", "x-enum-as-string": true }, "CoalescingTime": { "description": "The time to wait between interrupts or the idle period that must be encountered before an interrupt is sent. To turn off interrupt coalescing, enter 0 (zero) in this field.", "type": "integer", "format": "int64", "default": 125, "minimum": 0, "maximum": 65535, "x-omitempty": true }, "CoalescingType": { "description": "Interrupt Coalescing Type. This can be one of the following:- MIN - The system waits for the time specified in the Coalescing Time field before sending another interrupt event IDLE - The system does not send an interrupt until there is a period of no activity lasting as least as long as the time specified in the Coalescing Time field.\n* `MIN` - The system waits for the time specified in the Coalescing Time field before sending another interrupt event.\n* `IDLE` - The system does not send an interrupt until there is a period of no activity lasting as least as long as the time specified in the Coalescing Time field.", "type": "string", "enum": [ "MIN", "IDLE" ], "default": "MIN", "x-omitempty": true }, "Count": { "description": "The number of interrupt resources to allocate. Typical value is be equal to the number of completion queue resources.", "type": "integer", "format": "int64", "default": 8, "minimum": 1, "maximum": 1024, "x-omitempty": true }, "Mode": { "description": "Preferred driver interrupt mode. This can be one of the following:- MSIx - Message Signaled Interrupts (MSI) with the optional extension. MSI - MSI only. INTx - PCI INTx interrupts. MSIx is the recommended option.\n* `MSIx` - Message Signaled Interrupt (MSI) mechanism with the optional extension (MSIx). MSIx is the recommended and default option.\n* `MSI` - Message Signaled Interrupt (MSI) mechanism that treats messages as interrupts.\n* `INTx` - Line-based interrupt (INTx) mechanism similar to the one used in Legacy systems.", "type": "string", "enum": [ "MSIx", "MSI", "INTx" ], "default": "MSIx", "x-omitempty": true } } } ] }, "vnic.EthNetworkPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthNetworkPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthNetworkPolicy' resources.", "x-one-of-name": "vnic.EthNetworkPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthNetworkPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthNetworkPolicy.Relationship": { "description": "A relationship to the 'vnic.EthNetworkPolicy' resource, or the expanded 'vnic.EthNetworkPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.EthNetworkPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthNetworkPolicy": { "title": "Ethernet Network", "description": "The EthNetworkPolicy object controls the VLAN and Ethernet network configuration for virtual interfaces. It defines how VLAN traffic is managed and tagged as it traverses the network infrastructure. This policy applies only to standalone servers.\n#### Purpose\nEthNetworkPolicy enforces VLAN policies and traffic handling for vNICs, ensuring that network segmentation and access controls are applied consistently across all connected endpoints.\n#### Key Concepts\n- **VLAN Management:** Specifies access or trunk modes, native VLANs, and allowed VLANs for interfaces.\n- **Policy Attachment:** Linked to vNICs and LAN connectivity policies for unified configuration.", "x-allOf-name": "vnic.EthNetworkPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthNetworkPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthNetworkPolicy" ], "default": "vnic.EthNetworkPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthNetworkPolicy" ], "default": "vnic.EthNetworkPolicy", "x-enum-as-string": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "x-omitempty": true }, "VlanSettings": { "description": "VLAN configuration for the virtual interface.", "$ref": "#/components/schemas/vnic.VlanSettings", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.EthNetworkPolicy.List": { "title": "List of 'vnic.EthNetworkPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthNetworkPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthNetworkPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthNetworkPolicy" }, "nullable": true } } } ] }, "vnic.EthNetworkPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthNetworkPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthNetworkPolicyInventory' resources.", "x-one-of-name": "vnic.EthNetworkPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthNetworkPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.EthNetworkPolicyInventory' resource, or the expanded 'vnic.EthNetworkPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.EthNetworkPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthNetworkPolicyInventory": { "title": "Ethernet Network", "description": "The EthNetworkPolicy object controls the VLAN and Ethernet network configuration for virtual interfaces. It defines how VLAN traffic is managed and tagged as it traverses the network infrastructure. This policy applies only to standalone servers.\n#### Purpose\nEthNetworkPolicy enforces VLAN policies and traffic handling for vNICs, ensuring that network segmentation and access controls are applied consistently across all connected endpoints.\n#### Key Concepts\n- **VLAN Management:** Specifies access or trunk modes, native VLANs, and allowed VLANs for interfaces.\n- **Policy Attachment:** Linked to vNICs and LAN connectivity policies for unified configuration.", "x-allOf-name": "vnic.EthNetworkPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthNetworkPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthNetworkPolicyInventory" ], "default": "vnic.EthNetworkPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthNetworkPolicyInventory" ], "default": "vnic.EthNetworkPolicyInventory", "x-enum-as-string": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "readOnly": true, "x-omitempty": true }, "VlanSettings": { "description": "VLAN configuration for the virtual interface.", "$ref": "#/components/schemas/vnic.VlanSettings", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthNetworkPolicyInventory.List": { "title": "List of 'vnic.EthNetworkPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthNetworkPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthNetworkPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthNetworkPolicyInventory" }, "nullable": true } } } ] }, "vnic.EthQosPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthQosPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthQosPolicy' resources.", "x-one-of-name": "vnic.EthQosPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthQosPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthQosPolicy.Relationship": { "description": "A relationship to the 'vnic.EthQosPolicy' resource, or the expanded 'vnic.EthQosPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.EthQosPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthQosPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthQosPolicy": { "title": "Ethernet QoS", "description": "The EthQosPolicy object defines Quality of Service (QoS) parameters for Ethernet traffic on virtual network interfaces. It enables prioritization and control of outbound traffic for optimized performance.\n#### Purpose\nEthQosPolicy centralizes QoS settings, such as bandwidth limits and class of service, ensuring predictable and enforceable traffic behavior across vNICs.\n#### Key Concepts\n- **QoS Enforcement:** Regulates traffic classes, bandwidth, and packet handling.\n- **Integration with vNICs:** Directly associated with Ethernet interfaces for seamless policy application.\n- **Scalable Management:** Supports centralized control for consistent QoS across multiple environments.", "x-allOf-name": "vnic.EthQosPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthQosPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthQosPolicy" ], "default": "vnic.EthQosPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthQosPolicy" ], "default": "vnic.EthQosPolicy", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vNIC.", "type": "integer", "format": "int64", "default": 10240, "minimum": 1, "maximum": 1000000, "x-omitempty": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 6, "x-omitempty": true }, "Mtu": { "description": "The Maximum Transmission Unit (MTU) or packet size that the virtual interface accepts.Only 5th Gen Adapters and above with firmware version 5.4.2.15 and later support MTU size greater than 9000.", "type": "integer", "format": "int64", "default": 1500, "minimum": 1500, "maximum": 9158, "x-omitempty": true }, "Priority": { "description": "The priority matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps (0-10G/40G/100G depending on Adapter Model) to use for limiting the data rate on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "x-omitempty": true }, "TrustHostCos": { "description": "Enables usage of the Class of Service provided by the operating system.", "type": "boolean", "default": false, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.EthQosPolicy.List": { "title": "List of 'vnic.EthQosPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthQosPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthQosPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthQosPolicy" }, "nullable": true } } } ] }, "vnic.EthQosPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthQosPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthQosPolicyInventory' resources.", "x-one-of-name": "vnic.EthQosPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthQosPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.EthQosPolicyInventory' resource, or the expanded 'vnic.EthQosPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.EthQosPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.EthQosPolicyInventory": { "title": "Ethernet QoS", "description": "The EthQosPolicy object defines Quality of Service (QoS) parameters for Ethernet traffic on virtual network interfaces. It enables prioritization and control of outbound traffic for optimized performance.\n#### Purpose\nEthQosPolicy centralizes QoS settings, such as bandwidth limits and class of service, ensuring predictable and enforceable traffic behavior across vNICs.\n#### Key Concepts\n- **QoS Enforcement:** Regulates traffic classes, bandwidth, and packet handling.\n- **Integration with vNICs:** Directly associated with Ethernet interfaces for seamless policy application.\n- **Scalable Management:** Supports centralized control for consistent QoS across multiple environments.", "x-allOf-name": "vnic.EthQosPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthQosPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthQosPolicyInventory" ], "default": "vnic.EthQosPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthQosPolicyInventory" ], "default": "vnic.EthQosPolicyInventory", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vNIC.", "type": "integer", "format": "int64", "default": 10240, "minimum": 1, "maximum": 1000000, "readOnly": true, "x-omitempty": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 6, "readOnly": true, "x-omitempty": true }, "Mtu": { "description": "The Maximum Transmission Unit (MTU) or packet size that the virtual interface accepts.Only 5th Gen Adapters and above with firmware version 5.4.2.15 and later support MTU size greater than 9000.", "type": "integer", "format": "int64", "default": 1500, "minimum": 1500, "maximum": 9158, "readOnly": true, "x-omitempty": true }, "Priority": { "description": "The priority matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "readOnly": true, "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps (0-10G/40G/100G depending on Adapter Model) to use for limiting the data rate on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "readOnly": true, "x-omitempty": true }, "TrustHostCos": { "description": "Enables usage of the Class of Service provided by the operating system.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthQosPolicyInventory.List": { "title": "List of 'vnic.EthQosPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthQosPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthQosPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthQosPolicyInventory" }, "nullable": true } } } ] }, "vnic.EthRxQueueSettings": { "title": "Queue Settings", "description": "Receive Queue resource settings.", "x-allOf-name": "vnic.EthRxQueueSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthRxQueueSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthRxQueueSettings" ], "default": "vnic.EthRxQueueSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthRxQueueSettings" ], "default": "vnic.EthRxQueueSettings", "x-enum-as-string": true }, "Count": { "description": "The number of queue resources to allocate.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 1000, "x-omitempty": true }, "RingSize": { "description": "The number of descriptors in each queue.", "type": "integer", "format": "int64", "default": 4096, "minimum": 64, "maximum": 16384, "x-omitempty": true } } } ] }, "vnic.EthTxQueueSettings": { "title": "Queue Settings", "description": "Transmit Queue resource settings.", "x-allOf-name": "vnic.EthTxQueueSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthTxQueueSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthTxQueueSettings" ], "default": "vnic.EthTxQueueSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthTxQueueSettings" ], "default": "vnic.EthTxQueueSettings", "x-enum-as-string": true }, "Count": { "description": "The number of queue resources to allocate.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 1000, "x-omitempty": true }, "RingSize": { "description": "The number of descriptors in each queue.", "type": "integer", "format": "int64", "default": 4096, "minimum": 64, "maximum": 16384, "x-omitempty": true } } } ] }, "vnic.EthVethInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthVethInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthVethInventory' resources.", "x-one-of-name": "vnic.EthVethInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthVethInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthVethInventory": { "title": "Vethernet", "description": "QoS settings on FI corresponding to a server\u2019s vNIC.", "x-allOf-name": "vnic.EthVethInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthVethInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthVethInventory" ], "default": "vnic.EthVethInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthVethInventory" ], "default": "vnic.EthVethInventory", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vNIC.", "type": "integer", "format": "int64", "default": 1024, "minimum": 1024, "maximum": 1000000, "x-omitempty": true }, "Description": { "description": "Description of the virtual FC interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the virtual ethernet interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Priority": { "description": "The priortity matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "readOnly": true, "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps (0-10G/40G/100G depending on Adapter Model) to use for limiting the data rate on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthVethInventory.List": { "title": "List of 'vnic.EthVethInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthVethInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthVethInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthVethInventory" }, "nullable": true } } } ] }, "vnic.EthVnicInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.EthVnicInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.EthVnicInventory' resources.", "x-one-of-name": "vnic.EthVnicInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.EthVnicInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.EthVnicInventory": { "title": "Ethernet vnic", "description": "QoS settings of server\u2019s vNIC.", "x-allOf-name": "vnic.EthVnicInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.EthVnicInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.EthVnicInventory" ], "default": "vnic.EthVnicInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.EthVnicInventory" ], "default": "vnic.EthVnicInventory", "x-enum-as-string": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Mtu": { "description": "The Maximum Transmission Unit (MTU) or packet size that the virtual interface accepts.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the virtual ethernet interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "TrustHostCos": { "description": "Enables usage of the Class of Service provided by the operating system.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.EthVnicInventory.List": { "title": "List of 'vnic.EthVnicInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.EthVnicInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.EthVnicInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthVnicInventory" }, "nullable": true } } } ] }, "vnic.FcAdapterPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcAdapterPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcAdapterPolicy' resources.", "x-one-of-name": "vnic.FcAdapterPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcAdapterPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcAdapterPolicy.Relationship": { "description": "A relationship to the 'vnic.FcAdapterPolicy' resource, or the expanded 'vnic.FcAdapterPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.FcAdapterPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcAdapterPolicy": { "title": "Fibre Channel Adapter", "description": "The FcAdapterPolicy object manages the configuration and operational parameters of Fibre Channel adapters. It governs how adapters handle traffic, error recovery, and performance tuning.\n#### Purpose\nFcAdapterPolicy centralizes the management of advanced features for Fibre Channel adapters, including error recovery, queue management, and interrupt handling to maximize storage performance.\n#### Key Concepts\n- **Advanced Adapter Settings:** Controls error recovery, queue depths, and I/O throttling.\n- **Integration with vHBAs:** Applied to vHBA objects to govern their runtime behavior.", "x-allOf-name": "vnic.FcAdapterPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcAdapterPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcAdapterPolicy" ], "default": "vnic.FcAdapterPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcAdapterPolicy" ], "default": "vnic.FcAdapterPolicy", "x-enum-as-string": true }, "ErrorDetectionTimeout": { "description": "Error Detection Timeout, also referred to as EDTOV, is the number of milliseconds to wait before the system assumes that an error has occurred.", "type": "integer", "format": "int64", "default": 2000, "minimum": 1000, "maximum": 100000, "x-omitempty": true }, "ErrorRecoverySettings": { "description": "Fibre Channel Error Recovery Settings.", "$ref": "#/components/schemas/vnic.FcErrorRecoverySettings", "x-omitempty": true }, "FlogiSettings": { "description": "Fibre Channel Flogi Settings.", "$ref": "#/components/schemas/vnic.FlogiSettings", "x-omitempty": true }, "InterruptSettings": { "description": "Interrupt Settings for the virtual fibre channel interface.", "$ref": "#/components/schemas/vnic.FcInterruptSettings", "x-omitempty": true }, "IoThrottleCount": { "description": "The maximum number of data or control I/O operations that can be pending for the virtual interface at one time. If this value is exceeded, the additional I/O operations wait in the queue until the number of pending I/O operations decreases and the additional operations can be processed.", "type": "integer", "format": "int64", "default": 512, "minimum": 1, "maximum": 1024, "x-omitempty": true }, "LunCount": { "description": "The maximum number of LUNs that the Fibre Channel driver will export or show. The maximum number of LUNs is usually controlled by the operating system running on the server. Lun Count value can exceed 1024 only for vHBA of type 'FC Initiator' and on servers having supported firmware version.", "type": "integer", "format": "int64", "default": 1024, "minimum": 1, "maximum": 16384, "x-omitempty": true }, "LunQueueDepth": { "description": "The number of commands that the HBA can send and receive in a single transmission per LUN.", "type": "integer", "format": "int64", "default": 20, "minimum": 1, "maximum": 254, "x-omitempty": true }, "PlogiSettings": { "description": "Fibre Channel Plogi Settings.", "$ref": "#/components/schemas/vnic.PlogiSettings", "x-omitempty": true }, "ResourceAllocationTimeout": { "description": "Resource Allocation Timeout, also referred to as RATOV, is the number of milliseconds to wait before the system assumes that a resource cannot be properly allocated.", "type": "integer", "format": "int64", "default": 10000, "minimum": 5000, "maximum": 100000, "x-omitempty": true }, "RxQueueSettings": { "description": "Fibre Channel Receive Queue Settings.", "$ref": "#/components/schemas/vnic.FcQueueSettings", "x-omitempty": true }, "ScsiQueueSettings": { "description": "SCSI Input/Output Queue Settings.", "$ref": "#/components/schemas/vnic.ScsiQueueSettings", "x-omitempty": true }, "TxQueueSettings": { "description": "Fibre Channel Transmit Queue Settings.", "$ref": "#/components/schemas/vnic.FcQueueSettings", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.FcAdapterPolicy.List": { "title": "List of 'vnic.FcAdapterPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcAdapterPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcAdapterPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcAdapterPolicy" }, "nullable": true } } } ] }, "vnic.FcAdapterPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcAdapterPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcAdapterPolicyInventory' resources.", "x-one-of-name": "vnic.FcAdapterPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcAdapterPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.FcAdapterPolicyInventory' resource, or the expanded 'vnic.FcAdapterPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.FcAdapterPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcAdapterPolicyInventory": { "title": "Fibre Channel Adapter", "description": "The FcAdapterPolicy object manages the configuration and operational parameters of Fibre Channel adapters. It governs how adapters handle traffic, error recovery, and performance tuning.\n#### Purpose\nFcAdapterPolicy centralizes the management of advanced features for Fibre Channel adapters, including error recovery, queue management, and interrupt handling to maximize storage performance.\n#### Key Concepts\n- **Advanced Adapter Settings:** Controls error recovery, queue depths, and I/O throttling.\n- **Integration with vHBAs:** Applied to vHBA objects to govern their runtime behavior.", "x-allOf-name": "vnic.FcAdapterPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcAdapterPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcAdapterPolicyInventory" ], "default": "vnic.FcAdapterPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcAdapterPolicyInventory" ], "default": "vnic.FcAdapterPolicyInventory", "x-enum-as-string": true }, "ErrorDetectionTimeout": { "description": "Error Detection Timeout, also referred to as EDTOV, is the number of milliseconds to wait before the system assumes that an error has occurred.", "type": "integer", "format": "int64", "default": 2000, "minimum": 1000, "maximum": 100000, "readOnly": true, "x-omitempty": true }, "ErrorRecoverySettings": { "description": "Fibre Channel Error Recovery Settings.", "$ref": "#/components/schemas/vnic.FcErrorRecoverySettings", "readOnly": true, "x-omitempty": true }, "FlogiSettings": { "description": "Fibre Channel Flogi Settings.", "$ref": "#/components/schemas/vnic.FlogiSettings", "readOnly": true, "x-omitempty": true }, "InterruptSettings": { "description": "Interrupt Settings for the virtual fibre channel interface.", "$ref": "#/components/schemas/vnic.FcInterruptSettings", "readOnly": true, "x-omitempty": true }, "IoThrottleCount": { "description": "The maximum number of data or control I/O operations that can be pending for the virtual interface at one time. If this value is exceeded, the additional I/O operations wait in the queue until the number of pending I/O operations decreases and the additional operations can be processed.", "type": "integer", "format": "int64", "default": 512, "minimum": 1, "maximum": 1024, "readOnly": true, "x-omitempty": true }, "LunCount": { "description": "The maximum number of LUNs that the Fibre Channel driver will export or show. The maximum number of LUNs is usually controlled by the operating system running on the server. Lun Count value can exceed 1024 only for vHBA of type 'FC Initiator' and on servers having supported firmware version.", "type": "integer", "format": "int64", "default": 1024, "minimum": 1, "maximum": 16384, "readOnly": true, "x-omitempty": true }, "LunQueueDepth": { "description": "The number of commands that the HBA can send and receive in a single transmission per LUN.", "type": "integer", "format": "int64", "default": 20, "minimum": 1, "maximum": 254, "readOnly": true, "x-omitempty": true }, "PlogiSettings": { "description": "Fibre Channel Plogi Settings.", "$ref": "#/components/schemas/vnic.PlogiSettings", "readOnly": true, "x-omitempty": true }, "ResourceAllocationTimeout": { "description": "Resource Allocation Timeout, also referred to as RATOV, is the number of milliseconds to wait before the system assumes that a resource cannot be properly allocated.", "type": "integer", "format": "int64", "default": 10000, "minimum": 5000, "maximum": 100000, "readOnly": true, "x-omitempty": true }, "RxQueueSettings": { "description": "Fibre Channel Receive Queue Settings.", "$ref": "#/components/schemas/vnic.FcQueueSettings", "readOnly": true, "x-omitempty": true }, "ScsiQueueSettings": { "description": "SCSI Input/Output Queue Settings.", "$ref": "#/components/schemas/vnic.ScsiQueueSettings", "readOnly": true, "x-omitempty": true }, "TxQueueSettings": { "description": "Fibre Channel Transmit Queue Settings.", "$ref": "#/components/schemas/vnic.FcQueueSettings", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcAdapterPolicyInventory.List": { "title": "List of 'vnic.FcAdapterPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcAdapterPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcAdapterPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory" }, "nullable": true } } } ] }, "vnic.FcErrorRecoverySettings": { "title": "Error Recovery Settings", "description": "Fibre Channel Error Recovery Settings.", "x-allOf-name": "vnic.FcErrorRecoverySettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcErrorRecoverySettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcErrorRecoverySettings" ], "default": "vnic.FcErrorRecoverySettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcErrorRecoverySettings" ], "default": "vnic.FcErrorRecoverySettings", "x-enum-as-string": true }, "Enabled": { "description": "Enables Fibre Channel Error recovery.", "type": "boolean", "x-omitempty": true }, "IoRetryCount": { "description": "The number of times an I/O request to a port is retried because the port is busy before the system decides the port is unavailable.", "type": "integer", "format": "int64", "default": 8, "minimum": 0, "maximum": 255, "x-omitempty": true }, "IoRetryTimeout": { "description": "The number of seconds the adapter waits before aborting the pending command and resending the same IO request.", "type": "integer", "format": "int64", "default": 5, "minimum": 1, "maximum": 59, "x-omitempty": true }, "LinkDownTimeout": { "description": "The number of milliseconds the port should actually be down before it is marked down and fabric connectivity is lost.", "type": "integer", "format": "int64", "default": 30000, "minimum": 0, "maximum": 240000, "x-omitempty": true }, "PortDownTimeout": { "description": "The number of milliseconds a remote Fibre Channel port should be offline before informing the SCSI upper layer that the port is unavailable. For a server with a VIC adapter running ESXi, the recommended value is 10000. For a server with a port used to boot a Windows OS from the SAN, the recommended value is 5000 milliseconds.", "type": "integer", "format": "int64", "default": 10000, "minimum": 0, "maximum": 240000, "x-omitempty": true } } } ] }, "vnic.FcIf.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcIf' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcIf' resources.", "x-one-of-name": "vnic.FcIf.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcIf.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcIf.Relationship": { "description": "A relationship to the 'vnic.FcIf' resource, or the expanded 'vnic.FcIf' resource, or the 'null' value.", "x-one-of-name": "vnic.FcIf.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcIf" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcIf": { "title": "Virtual Fibre Channel Interface", "description": "Virtual Fibre Channel Interface.", "x-allOf-name": "vnic.FcIf", "allOf": [ { "$ref": "#/components/schemas/vnic.BaseFcIf" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcIf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcIf" ], "default": "vnic.FcIf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcIf" ], "default": "vnic.FcIf", "x-enum-as-string": true }, "Name": { "description": "Name of the virtual fibre channel interface.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\._:]+$", "maxLength": 31, "x-omitempty": true }, "OldInfo": { "description": "Deployed information related to lease and vif id.", "$ref": "#/components/schemas/vnic.FcIfOldInfo", "readOnly": true, "x-omitempty": true }, "Order": { "description": "The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The order should start from zero with no overlaps. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1340, VIC 1380 and VIC 1385 which have two.", "type": "integer", "format": "int64", "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "x-omitempty": true }, "Stale": { "description": "The FcIf object represents a virtual Fibre Channel interface (vHBA) within the Cisco environment. It abstracts the configuration and management of storage connectivity for servers.\n#### Purpose\nFcIf provides a programmable interface for defining, deploying, and managing vHBAs, ensuring that storage resources are accessible and policy-compliant.\n#### Key Concepts\n- **Storage Connectivity Abstraction:** Represents the vHBA as a managed object.\n- **Policy-Driven Configuration:** Associates with SAN, QoS, and adapter policies for end-to-end control.\n- **Template and Override Support:** Can derive configuration from templates with support for property overrides.\n- **Integration with Zoning and WWN Pools:** Facilitates automated and secure storage access.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StaticWwpnAddress": { "description": "The WWPN address must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.\nAllowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.\nTo ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "This should be the same as the channel number of the vfc created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vfc is created on the switch for every vHBA.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Wwpn": { "description": "The WWPN address that is assigned to the vHBA based on the wwn pool that has been assigned to the SAN Connectivity Policy.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "WwpnAddressType": { "description": "Type of allocation selected to assign a WWPN address to the vhba.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "x-omitempty": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "SanConnectivityPolicy": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy.Relationship", "description": "A reference to a vnicSanConnectivityPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "ScpVhba": { "$ref": "#/components/schemas/vnic.FcIf.Relationship", "description": "A reference to a vnicFcIf resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SpVhbas": { "description": "An array of relationships to vnicFcIf resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIf.Relationship" }, "nullable": true, "readOnly": true }, "SrcTemplate": { "$ref": "#/components/schemas/vnic.VhbaTemplate.Relationship", "description": "A reference to a vnicVhbaTemplate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "WwpnLease": { "$ref": "#/components/schemas/fcpool.Lease.Relationship", "description": "A reference to a fcpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.FcIf.List": { "title": "List of 'vnic.FcIf' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcIf' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcIf' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIf" }, "nullable": true } } } ] }, "vnic.FcIfInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcIfInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcIfInventory' resources.", "x-one-of-name": "vnic.FcIfInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcIfInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcIfInventory.Relationship": { "description": "A relationship to the 'vnic.FcIfInventory' resource, or the expanded 'vnic.FcIfInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.FcIfInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcIfInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcIfInventory": { "title": "Virtual Fibre Channel Interface", "description": "Virtual Fibre Channel Interface.", "x-allOf-name": "vnic.FcIfInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcIfInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcIfInventory" ], "default": "vnic.FcIfInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcIfInventory" ], "default": "vnic.FcIfInventory", "x-enum-as-string": true }, "Name": { "description": "Name of the virtual fibre channel interface.", "type": "string", "pattern": "^[a-zA-Z0-9\\-\\._:]+$", "maxLength": 31, "readOnly": true, "x-omitempty": true }, "OldInfo": { "description": "Deployed information related to lease and vif id.", "$ref": "#/components/schemas/vnic.FcIfOldInfo", "readOnly": true, "x-omitempty": true }, "Order": { "description": "The order in which the virtual interface is brought up. The order assigned to an interface should be unique for all the Ethernet and Fibre-Channel interfaces on each PCI link on a VIC adapter. The order should start from zero with no overlaps. The maximum value of PCI order is limited by the number of virtual interfaces (Ethernet and Fibre-Channel) on each PCI link on a VIC adapter. All VIC adapters have a single PCI link except VIC 1340, VIC 1380 and VIC 1385 which have two.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "PersistentBindings": { "description": "Enables retention of LUN ID associations in memory until they are manually cleared.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "PinGroupName": { "description": "Pingroup name associated to vfc for static pinning. SCP deploy will resolve pingroup name and fetches the correspoding uplink port/port channel to pin the vfc traffic.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.:-]{1,64}$", "readOnly": true, "x-omitempty": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "readOnly": true, "x-omitempty": true }, "Stale": { "description": "The FcIf object represents a virtual Fibre Channel interface (vHBA) within the Cisco environment. It abstracts the configuration and management of storage connectivity for servers.\n#### Purpose\nFcIf provides a programmable interface for defining, deploying, and managing vHBAs, ensuring that storage resources are accessible and policy-compliant.\n#### Key Concepts\n- **Storage Connectivity Abstraction:** Represents the vHBA as a managed object.\n- **Policy-Driven Configuration:** Associates with SAN, QoS, and adapter policies for end-to-end control.\n- **Template and Override Support:** Can derive configuration from templates with support for property overrides.\n- **Integration with Zoning and WWN Pools:** Facilitates automated and secure storage access.", "type": "boolean", "readOnly": true, "x-omitempty": true }, "StaticWwpnAddress": { "description": "The WWPN address must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.\nAllowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.\nTo ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "Type": { "description": "VHBA Type configuration for SAN Connectivity Policy. This configuration is supported only on Cisco VIC 14XX series and higher series of adapters.\n* `fc-initiator` - The default value set for vHBA Type Configuration. Fc-initiator specifies vHBA as a consumer of storage. Enables SCSI commands to transfer data and status information between host and target storage systems.\n* `fc-nvme-initiator` - Fc-nvme-initiator specifies vHBA as a consumer of storage. Enables NVMe-based message commands to transfer data and status information between host and target storage systems.\n* `fc-nvme-target` - Fc-nvme-target specifies vHBA as a provider of storage volumes to initiators. Enables NVMe-based message commands to transfer data and status information between host and target storage systems. Currently tech-preview, only enabled with an asynchronous driver.\n* `fc-target` - Fc-target specifies vHBA as a provider of storage volumes to initiators. Enables SCSI commands to transfer data and status information between host and target storage systems. fc-target is enabled only with an asynchronous driver.", "type": "string", "enum": [ "fc-initiator", "fc-nvme-initiator", "fc-nvme-target", "fc-target" ], "default": "fc-initiator", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "This should be the same as the channel number of the vfc created on switch in order to set up the data path. The property is applicable only for FI attached servers where a vfc is created on the switch for every vHBA.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Wwpn": { "description": "The WWPN address that is assigned to the vHBA based on the wwn pool that has been assigned to the SAN Connectivity Policy.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "WwpnAddressType": { "description": "Type of allocation selected to assign a WWPN address to the vhba.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "FcAdapterPolicy": { "$ref": "#/components/schemas/vnic.FcAdapterPolicyInventory.Relationship", "description": "A reference to a vnicFcAdapterPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FcNetworkPolicy": { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory.Relationship", "description": "A reference to a vnicFcNetworkPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FcQosPolicy": { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory.Relationship", "description": "A reference to a vnicFcQosPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "FcZonePolicies": { "description": "An array of relationships to fabricFcZonePolicy resources.", "type": "array", "items": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/fabric.FcZonePolicy.Relationship" }, "nullable": true, "readOnly": true }, "SanConnectivityPolicy": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory.Relationship", "description": "A reference to a vnicSanConnectivityPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "ScpVhba": { "$ref": "#/components/schemas/vnic.FcIfInventory.Relationship", "description": "A reference to a vnicFcIfInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SpVhbas": { "description": "An array of relationships to vnicFcIfInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIfInventory.Relationship" }, "nullable": true, "readOnly": true }, "SrcTemplate": { "$ref": "#/components/schemas/vnic.VhbaTemplate.Relationship", "description": "A reference to a vnicVhbaTemplate resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WwpnLease": { "$ref": "#/components/schemas/fcpool.Lease.Relationship", "description": "A reference to a fcpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WwpnPool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcIfInventory.List": { "title": "List of 'vnic.FcIfInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcIfInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcIfInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIfInventory" }, "nullable": true } } } ] }, "vnic.FcIfOldInfo": { "title": "FcIf Old Deployed Info", "description": "Deployed information related to lease and vif id.", "x-allOf-name": "vnic.FcIfOldInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcIfOldInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcIfOldInfo" ], "default": "vnic.FcIfOldInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcIfOldInfo" ], "default": "vnic.FcIfOldInfo", "x-enum-as-string": true }, "StaticWwpnAddress": { "description": "The WWPN address must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.\nAllowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.\nTo ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "Old Vif id that was associated with the interface.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Wwpn": { "description": "The WWPN address that is assigned to the vHBA based on the wwn pool that has been assigned to the SAN Connectivity Policy.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "WwpnAddressType": { "description": "Type of allocation selected to assign a WWPN address to the vhba.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "WwpnPool": { "description": "WWPN Pool configured in the SAN Connectivity Policy.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "Wwpnlease": { "description": "WWPN Lease taken for the vhba configured in the San Connectivity Policy.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true } } } ] }, "vnic.FcInterruptSettings": { "title": "Interrupt Settings", "description": "Interrupt Settings for the virtual fibre channel interface.", "x-allOf-name": "vnic.FcInterruptSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcInterruptSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcInterruptSettings" ], "default": "vnic.FcInterruptSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcInterruptSettings" ], "default": "vnic.FcInterruptSettings", "x-enum-as-string": true }, "Mode": { "description": "The preferred driver interrupt mode. This can be one of the following:- MSIx - Message Signaled Interrupts (MSI) with the optional extension. MSI - MSI only. INTx - PCI INTx interrupts. MSIx is the recommended option.\n* `MSIx` - Message Signaled Interrupt (MSI) mechanism with the optional extension (MSIx). MSIx is the recommended and default option.\n* `MSI` - Message Signaled Interrupt (MSI) mechanism that treats messages as interrupts.\n* `INTx` - Line-based interrupt (INTx) mechanism similar to the one used in Legacy systems.", "type": "string", "enum": [ "MSIx", "MSI", "INTx" ], "default": "MSIx", "x-omitempty": true } } } ] }, "vnic.FcNetworkPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcNetworkPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcNetworkPolicy' resources.", "x-one-of-name": "vnic.FcNetworkPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcNetworkPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcNetworkPolicy.Relationship": { "description": "A relationship to the 'vnic.FcNetworkPolicy' resource, or the expanded 'vnic.FcNetworkPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.FcNetworkPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcNetworkPolicy": { "title": "Fibre Channel Network", "description": "The FcNetworkPolicy object defines Fibre Channel network settings, particularly the configuration of vSANs for virtual Fibre Channel interfaces.\n#### Purpose\nFcNetworkPolicy abstracts the vSAN configuration, enabling centralized, policy-based management of storage network segmentation and access.\n#### Key Concepts\n- **vSAN Configuration:** Specifies vSAN IDs and related settings for storage connectivity.\n- **Policy-Based Management:** Ensures consistent SAN segmentation across all managed endpoints.\n- **Integration with vHBAs:** Directly linked to vHBA configurations for seamless deployment.", "x-allOf-name": "vnic.FcNetworkPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcNetworkPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcNetworkPolicy" ], "default": "vnic.FcNetworkPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcNetworkPolicy" ], "default": "vnic.FcNetworkPolicy", "x-enum-as-string": true }, "VsanSettings": { "description": "Configuration of vSAN for the virtual interface.", "$ref": "#/components/schemas/vnic.VsanSettings", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.FcNetworkPolicy.List": { "title": "List of 'vnic.FcNetworkPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcNetworkPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcNetworkPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcNetworkPolicy" }, "nullable": true } } } ] }, "vnic.FcNetworkPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcNetworkPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcNetworkPolicyInventory' resources.", "x-one-of-name": "vnic.FcNetworkPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcNetworkPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.FcNetworkPolicyInventory' resource, or the expanded 'vnic.FcNetworkPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.FcNetworkPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcNetworkPolicyInventory": { "title": "Fibre Channel Network", "description": "The FcNetworkPolicy object defines Fibre Channel network settings, particularly the configuration of vSANs for virtual Fibre Channel interfaces.\n#### Purpose\nFcNetworkPolicy abstracts the vSAN configuration, enabling centralized, policy-based management of storage network segmentation and access.\n#### Key Concepts\n- **vSAN Configuration:** Specifies vSAN IDs and related settings for storage connectivity.\n- **Policy-Based Management:** Ensures consistent SAN segmentation across all managed endpoints.\n- **Integration with vHBAs:** Directly linked to vHBA configurations for seamless deployment.", "x-allOf-name": "vnic.FcNetworkPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcNetworkPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcNetworkPolicyInventory" ], "default": "vnic.FcNetworkPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcNetworkPolicyInventory" ], "default": "vnic.FcNetworkPolicyInventory", "x-enum-as-string": true }, "VsanSettings": { "description": "Configuration of vSAN for the virtual interface.", "$ref": "#/components/schemas/vnic.VsanSettings", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcNetworkPolicyInventory.List": { "title": "List of 'vnic.FcNetworkPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcNetworkPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcNetworkPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcNetworkPolicyInventory" }, "nullable": true } } } ] }, "vnic.FcQosPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcQosPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcQosPolicy' resources.", "x-one-of-name": "vnic.FcQosPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcQosPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcQosPolicy.Relationship": { "description": "A relationship to the 'vnic.FcQosPolicy' resource, or the expanded 'vnic.FcQosPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.FcQosPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcQosPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcQosPolicy": { "title": "Fibre Channel QoS", "description": "The FcQosPolicy object specifies Quality of Service (QoS) for Fibre Channel traffic on virtual HBAs, enabling administrators to control bandwidth, priority, and class of service for storage communications.\n#### Purpose\nFcQosPolicy ensures storage traffic receives appropriate prioritization and resource allocation, optimizing performance and reliability for storage-intensive workloads.\n#### Key Concepts\n- **Storage QoS Control:** Sets limits and priorities for Fibre Channel data flows.\n- **Integration with vHBAs:** Applied to virtual HBAs for consistent QoS enforcement.", "x-allOf-name": "vnic.FcQosPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcQosPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcQosPolicy" ], "default": "vnic.FcQosPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcQosPolicy" ], "default": "vnic.FcQosPolicy", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vHBA.", "type": "integer", "format": "int64", "default": 10240, "minimum": 1, "maximum": 1000000, "x-omitempty": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 3, "minimum": 0, "maximum": 6, "x-omitempty": true }, "MaxDataFieldSize": { "description": "The maximum size of the Fibre Channel frame payload bytes that the virtual interface supports.", "type": "integer", "format": "int64", "default": 2112, "minimum": 256, "maximum": 2112, "x-omitempty": true }, "Priority": { "description": "The priortity matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "readOnly": true, "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps to use for limiting the data rate on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.FcQosPolicy.List": { "title": "List of 'vnic.FcQosPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcQosPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcQosPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcQosPolicy" }, "nullable": true } } } ] }, "vnic.FcQosPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcQosPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcQosPolicyInventory' resources.", "x-one-of-name": "vnic.FcQosPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcQosPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.FcQosPolicyInventory' resource, or the expanded 'vnic.FcQosPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.FcQosPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.FcQosPolicyInventory": { "title": "Fibre Channel QoS", "description": "The FcQosPolicy object specifies Quality of Service (QoS) for Fibre Channel traffic on virtual HBAs, enabling administrators to control bandwidth, priority, and class of service for storage communications.\n#### Purpose\nFcQosPolicy ensures storage traffic receives appropriate prioritization and resource allocation, optimizing performance and reliability for storage-intensive workloads.\n#### Key Concepts\n- **Storage QoS Control:** Sets limits and priorities for Fibre Channel data flows.\n- **Integration with vHBAs:** Applied to virtual HBAs for consistent QoS enforcement.", "x-allOf-name": "vnic.FcQosPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcQosPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcQosPolicyInventory" ], "default": "vnic.FcQosPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcQosPolicyInventory" ], "default": "vnic.FcQosPolicyInventory", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vHBA.", "type": "integer", "format": "int64", "default": 10240, "minimum": 1, "maximum": 1000000, "readOnly": true, "x-omitempty": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 3, "minimum": 0, "maximum": 6, "readOnly": true, "x-omitempty": true }, "MaxDataFieldSize": { "description": "The maximum size of the Fibre Channel frame payload bytes that the virtual interface supports.", "type": "integer", "format": "int64", "default": 2112, "minimum": 256, "maximum": 2112, "readOnly": true, "x-omitempty": true }, "Priority": { "description": "The priortity matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "readOnly": true, "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps to use for limiting the data rate on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcQosPolicyInventory.List": { "title": "List of 'vnic.FcQosPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcQosPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcQosPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcQosPolicyInventory" }, "nullable": true } } } ] }, "vnic.FcQueueSettings": { "title": "Queue Settings", "description": "Transmit/Receive Queue resource settings.", "x-allOf-name": "vnic.FcQueueSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcQueueSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcQueueSettings" ], "default": "vnic.FcQueueSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcQueueSettings" ], "default": "vnic.FcQueueSettings", "x-enum-as-string": true }, "Count": { "description": "The number of queue resources to allocate.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 1, "readOnly": true, "x-omitempty": true }, "RingSize": { "description": "The number of descriptors in each queue. The maximum value for Transmit queue is 128 and for Receive queue is 2048.", "type": "integer", "format": "int64", "default": 64, "minimum": 64, "x-omitempty": true } } } ] }, "vnic.FcVethInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcVethInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcVethInventory' resources.", "x-one-of-name": "vnic.FcVethInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcVethInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcVethInventory": { "title": "Fibre Channel Vethernet", "description": "A Fibre Channel Quality of Service (QoS) policy assigns a system class to the outgoing traffic for a vHBA. This system class determines the quality of service for the outgoing traffic. For certain adapters additional controls can also be specified like burst and rate on the outgoing traffic.", "x-allOf-name": "vnic.FcVethInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcVethInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcVethInventory" ], "default": "vnic.FcVethInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcVethInventory" ], "default": "vnic.FcVethInventory", "x-enum-as-string": true }, "Burst": { "description": "The burst traffic, in bytes, allowed on the vNIC.", "type": "integer", "format": "int64", "default": 1024, "minimum": 1024, "maximum": 1000000, "x-omitempty": true }, "Description": { "description": "Description of the virtual FC interface.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the virtual FC interface.", "type": "string", "x-omitempty": true }, "RateLimit": { "description": "The value in Mbps to use for limiting the data rate on the virtual interface. Setting this to zero will turn rate limiting off.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 100000, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcVethInventory.List": { "title": "List of 'vnic.FcVethInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcVethInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcVethInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcVethInventory" }, "nullable": true } } } ] }, "vnic.FcVhbaPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.FcVhbaPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.FcVhbaPolicyInventory' resources.", "x-one-of-name": "vnic.FcVhbaPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.FcVhbaPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.FcVhbaPolicyInventory": { "title": "Fibre Channel Vhba", "description": "A Fibre Channel Quality of Service (QoS) policy assigns a system class to the outgoing traffic for a vHBA. This system class determines the quality of service for the outgoing traffic. For certain adapters additional controls can also be specified like burst and rate on the outgoing traffic.", "x-allOf-name": "vnic.FcVhbaPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FcVhbaPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FcVhbaPolicyInventory" ], "default": "vnic.FcVhbaPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FcVhbaPolicyInventory" ], "default": "vnic.FcVhbaPolicyInventory", "x-enum-as-string": true }, "Cos": { "description": "Class of Service to be associated to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 3, "minimum": 0, "maximum": 6, "x-omitempty": true }, "MaxDataFieldSize": { "description": "The maximum size of the Fibre Channel frame payload bytes that the virtual interface supports.", "type": "integer", "format": "int64", "default": 2112, "minimum": 256, "maximum": 2112, "x-omitempty": true }, "Name": { "description": "Name of the virtual HBA interface.", "type": "string", "x-omitempty": true }, "Priority": { "description": "The priortity matching the System QoS specified in the fabric profile.\n* `Best Effort` - QoS Priority for Best-effort traffic.\n* `FC` - QoS Priority for FC traffic.\n* `Platinum` - QoS Priority for Platinum traffic.\n* `Gold` - QoS Priority for Gold traffic.\n* `Silver` - QoS Priority for Silver traffic.\n* `Bronze` - QoS Priority for Bronze traffic.", "type": "string", "enum": [ "Best Effort", "FC", "Platinum", "Gold", "Silver", "Bronze" ], "default": "Best Effort", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.FcVhbaPolicyInventory.List": { "title": "List of 'vnic.FcVhbaPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.FcVhbaPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.FcVhbaPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcVhbaPolicyInventory" }, "nullable": true } } } ] }, "vnic.FlogiSettings": { "title": "Flogi Settings", "description": "Fibre Channel Flogi Settings.", "x-allOf-name": "vnic.FlogiSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.FlogiSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.FlogiSettings" ], "default": "vnic.FlogiSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.FlogiSettings" ], "default": "vnic.FlogiSettings", "x-enum-as-string": true }, "Retries": { "description": "The number of times that the system tries to log in to the fabric after the first failure. Allowed range is 0-4294967295.", "type": "integer", "format": "int64", "default": 8, "minimum": 0, "x-omitempty": true }, "Timeout": { "description": "The number of milliseconds that the system waits before it tries to log in again.", "type": "integer", "format": "int64", "default": 4000, "minimum": 1000, "maximum": 255000, "x-omitempty": true } } } ] }, "vnic.IscsiAdapterPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiAdapterPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiAdapterPolicy' resources.", "x-one-of-name": "vnic.IscsiAdapterPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiAdapterPolicy.Relationship": { "description": "A relationship to the 'vnic.IscsiAdapterPolicy' resource, or the expanded 'vnic.IscsiAdapterPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiAdapterPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiAdapterPolicy": { "title": "iSCSI Adapter", "description": "The IscsiAdapterPolicy object governs the operational behavior of iSCSI adapters, including timeout and retry settings, to ensure robust and reliable storage connectivity.\n#### Purpose \nIscsiAdapterPolicy provides fine-grained control over iSCSI adapter parameters, optimizing connectivity and performance for network-based storage.\n#### Key Concepts\n- **Operational Control:** Manages connection timeouts, retry counts, and DHCP timeouts for iSCSI operations.\n- *Integration with Boot Policies:** Works in tandem with iSCSI boot and target policies.", "x-allOf-name": "vnic.IscsiAdapterPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiAdapterPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiAdapterPolicy" ], "default": "vnic.IscsiAdapterPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiAdapterPolicy" ], "default": "vnic.IscsiAdapterPolicy", "x-enum-as-string": true }, "ConnectionTimeOut": { "description": "The number of seconds to wait until Cisco UCS assumes that the initial login has failed and the iSCSI adapter is unavailable.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 255, "x-omitempty": true }, "DhcpTimeout": { "description": "The number of seconds to wait before the initiator assumes that the DHCP server is unavailable.", "type": "integer", "format": "int64", "minimum": 60, "maximum": 300, "x-omitempty": true }, "LunBusyRetryCount": { "description": "The number of times to retry the connection in case of a failure during iSCSI LUN discovery.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 60, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.IscsiAdapterPolicy.List": { "title": "List of 'vnic.IscsiAdapterPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiAdapterPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiAdapterPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy" }, "nullable": true } } } ] }, "vnic.IscsiAdapterPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiAdapterPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiAdapterPolicyInventory' resources.", "x-one-of-name": "vnic.IscsiAdapterPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiAdapterPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.IscsiAdapterPolicyInventory' resource, or the expanded 'vnic.IscsiAdapterPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiAdapterPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiAdapterPolicyInventory": { "title": "iSCSI Adapter", "description": "The IscsiAdapterPolicy object governs the operational behavior of iSCSI adapters, including timeout and retry settings, to ensure robust and reliable storage connectivity.\n#### Purpose \nIscsiAdapterPolicy provides fine-grained control over iSCSI adapter parameters, optimizing connectivity and performance for network-based storage.\n#### Key Concepts\n- **Operational Control:** Manages connection timeouts, retry counts, and DHCP timeouts for iSCSI operations.\n- *Integration with Boot Policies:** Works in tandem with iSCSI boot and target policies.", "x-allOf-name": "vnic.IscsiAdapterPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiAdapterPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiAdapterPolicyInventory" ], "default": "vnic.IscsiAdapterPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiAdapterPolicyInventory" ], "default": "vnic.IscsiAdapterPolicyInventory", "x-enum-as-string": true }, "ConnectionTimeOut": { "description": "The number of seconds to wait until Cisco UCS assumes that the initial login has failed and the iSCSI adapter is unavailable.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 255, "readOnly": true, "x-omitempty": true }, "DhcpTimeout": { "description": "The number of seconds to wait before the initiator assumes that the DHCP server is unavailable.", "type": "integer", "format": "int64", "minimum": 60, "maximum": 300, "readOnly": true, "x-omitempty": true }, "LunBusyRetryCount": { "description": "The number of times to retry the connection in case of a failure during iSCSI LUN discovery.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 60, "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.IscsiAdapterPolicyInventory.List": { "title": "List of 'vnic.IscsiAdapterPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiAdapterPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiAdapterPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory" }, "nullable": true } } } ] }, "vnic.IscsiAuthProfile": { "title": "Iscsi Authentication Profile", "description": "Challenge Handshake Authentication Protocol for iSCSI (CHAP) authentication parameters.", "x-allOf-name": "vnic.IscsiAuthProfile", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiAuthProfile', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiAuthProfile" ], "default": "vnic.IscsiAuthProfile", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiAuthProfile" ], "default": "vnic.IscsiAuthProfile", "x-enum-as-string": true }, "IsPasswordSet": { "description": "Indicates whether the value of the 'password' property has been set.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "Password": { "description": "Password of Initiator/Target Interface. Enter between 12 and 16 characters, including special characters except spaces, tabs, line breaks.", "type": "string", "pattern": "^$|^[\\S+]{12,16}$", "writeOnly": true, "x-omitempty": true }, "UserId": { "description": "User Id of Initiator/Target Interface. Enter between 1 and 128 characters, spaces, or special characters.", "type": "string", "pattern": "^$|^.{1,128}$", "x-omitempty": true } } } ] }, "vnic.IscsiBootPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiBootPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiBootPolicy' resources.", "x-one-of-name": "vnic.IscsiBootPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiBootPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiBootPolicy.Relationship": { "description": "A relationship to the 'vnic.IscsiBootPolicy' resource, or the expanded 'vnic.IscsiBootPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiBootPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiBootPolicy": { "title": "iSCSI Boot", "description": "The IscsiBootPolicy object encapsulates the configuration required to enable servers to boot from remote iSCSI targets over the network. \n#### Purpose\nIscsiBootPolicy automates and standardizes the process of configuring iSCSI boot, including authentication, target selection, and IP address assignment, to ensure reliable and secure remote booting.\n#### Key Concepts\n- **Remote Boot Enablement:** Supports network-based operating system boot via iSCSI.\n- **Comprehensive Configuration:** Manages authentication, IP assignment, and target discovery.\n- **Policy Integration:** Links to adapter and IP pool policies for end-to-end automation.", "x-allOf-name": "vnic.IscsiBootPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiBootPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiBootPolicy" ], "default": "vnic.IscsiBootPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiBootPolicy" ], "default": "vnic.IscsiBootPolicy", "x-enum-as-string": true }, "AutoTargetvendorName": { "description": "Auto target interface that is represented via the Initiator name or the DHCP vendor ID. Accepted length: 1 to 63 characters.", "type": "string", "x-omitempty": true }, "Chap": { "description": "CHAP authentication parameters for iSCSI Target.", "$ref": "#/components/schemas/vnic.IscsiAuthProfile", "x-omitempty": true }, "InitiatorIpSource": { "description": "Source Type of Initiator IP Address - Auto/Static/Pool.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "DHCP", "Static", "Pool" ], "default": "DHCP", "x-omitempty": true }, "InitiatorStaticIpV4Address": { "description": "Static IPv4 address provided for iSCSI Initiator.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "x-omitempty": true }, "InitiatorStaticIpV4Config": { "description": "IPV4 configurations such as Netmask, Gateway and DNS for iSCSI Initiator.", "$ref": "#/components/schemas/ippool.IpV4Config", "x-omitempty": true }, "InitiatorStaticIpV6Address": { "description": "Static IPv6 address provided for iSCSI Initiator.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "x-omitempty": true }, "InitiatorStaticIpV6Config": { "description": "IPv6 configurations such as Prefix, Gateway and DNS for iSCSI Initiator.", "$ref": "#/components/schemas/ippool.IpV6Config", "x-omitempty": true }, "IscsiIpType": { "description": "Type of the IP address requested for iSCSI vNIC - IPv4/IPv6.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-omitempty": true }, "MutualChap": { "description": "Mutual CHAP authentication parameters for iSCSI Initiator. Two-way CHAP mechanism.", "$ref": "#/components/schemas/vnic.IscsiAuthProfile", "x-omitempty": true }, "TargetSourceType": { "description": "Source Type of Targets - Auto/Static.\n* `Static` - Type indicates that static target interface is assigned to iSCSI boot.\n* `Auto` - Type indicates that the system selects the target interface automatically during iSCSI boot.", "type": "string", "enum": [ "Static", "Auto" ], "default": "Static", "x-omitempty": true }, "InitiatorIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "IscsiAdapterPolicy": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicy.Relationship", "description": "A reference to a vnicIscsiAdapterPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "PrimaryTargetPolicy": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy.Relationship", "description": "A reference to a vnicIscsiStaticTargetPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "SecondaryTargetPolicy": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy.Relationship", "description": "A reference to a vnicIscsiStaticTargetPolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.IscsiBootPolicy.List": { "title": "List of 'vnic.IscsiBootPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiBootPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiBootPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiBootPolicy" }, "nullable": true } } } ] }, "vnic.IscsiBootPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiBootPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiBootPolicyInventory' resources.", "x-one-of-name": "vnic.IscsiBootPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiBootPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.IscsiBootPolicyInventory' resource, or the expanded 'vnic.IscsiBootPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiBootPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiBootPolicyInventory": { "title": "iSCSI Boot", "description": "The IscsiBootPolicy object encapsulates the configuration required to enable servers to boot from remote iSCSI targets over the network. \n#### Purpose\nIscsiBootPolicy automates and standardizes the process of configuring iSCSI boot, including authentication, target selection, and IP address assignment, to ensure reliable and secure remote booting.\n#### Key Concepts\n- **Remote Boot Enablement:** Supports network-based operating system boot via iSCSI.\n- **Comprehensive Configuration:** Manages authentication, IP assignment, and target discovery.\n- **Policy Integration:** Links to adapter and IP pool policies for end-to-end automation.", "x-allOf-name": "vnic.IscsiBootPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiBootPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiBootPolicyInventory" ], "default": "vnic.IscsiBootPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiBootPolicyInventory" ], "default": "vnic.IscsiBootPolicyInventory", "x-enum-as-string": true }, "AutoTargetvendorName": { "description": "Auto target interface that is represented via the Initiator name or the DHCP vendor ID. Accepted length: 1 to 63 characters.", "type": "string", "readOnly": true, "x-omitempty": true }, "Chap": { "description": "CHAP authentication parameters for iSCSI Target.", "$ref": "#/components/schemas/vnic.IscsiAuthProfile", "readOnly": true, "x-omitempty": true }, "InitiatorIpSource": { "description": "Source Type of Initiator IP Address - Auto/Static/Pool.\n* `DHCP` - The IP address is assigned using DHCP, if available.\n* `Static` - Static IPv4 address is assigned to the iSCSI boot interface based on the information entered in this area.\n* `Pool` - An IPv4 address is assigned to the iSCSI boot interface from the management IP address pool.", "type": "string", "enum": [ "DHCP", "Static", "Pool" ], "default": "DHCP", "readOnly": true, "x-omitempty": true }, "InitiatorStaticIpV4Address": { "description": "Static IPv4 address provided for iSCSI Initiator.", "type": "string", "pattern": "^$|^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$", "readOnly": true, "x-omitempty": true }, "InitiatorStaticIpV4Config": { "description": "IPV4 configurations such as Netmask, Gateway and DNS for iSCSI Initiator.", "$ref": "#/components/schemas/ippool.IpV4Config", "readOnly": true, "x-omitempty": true }, "InitiatorStaticIpV6Address": { "description": "Static IPv6 address provided for iSCSI Initiator.", "type": "string", "pattern": "^$|^(([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:([0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{0,4}|:[0-9A-Fa-f]{1,4})?|(:[0-9A-Fa-f]{1,4}){0,2})|(:[0-9A-Fa-f]{1,4}){0,3})|(:[0-9A-Fa-f]{1,4}){0,4})|:(:[0-9A-Fa-f]{1,4}){0,5})((:[0-9A-Fa-f]{1,4}){2}|:(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])(\\.(25[0-5]|(2[0-4]|1[0-9]|[1-9])?[0-9])){3})|(([0-9A-Fa-f]{1,4}:){1,6}|:):[0-9A-Fa-f]{0,4}|([0-9A-Fa-f]{1,4}:){7}:)$", "readOnly": true, "x-omitempty": true }, "InitiatorStaticIpV6Config": { "description": "IPv6 configurations such as Prefix, Gateway and DNS for iSCSI Initiator.", "$ref": "#/components/schemas/ippool.IpV6Config", "readOnly": true, "x-omitempty": true }, "IscsiIpType": { "description": "Type of the IP address requested for iSCSI vNIC - IPv4/IPv6.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "readOnly": true, "x-omitempty": true }, "MutualChap": { "description": "Mutual CHAP authentication parameters for iSCSI Initiator. Two-way CHAP mechanism.", "$ref": "#/components/schemas/vnic.IscsiAuthProfile", "readOnly": true, "x-omitempty": true }, "TargetSourceType": { "description": "Source Type of Targets - Auto/Static.\n* `Static` - Type indicates that static target interface is assigned to iSCSI boot.\n* `Auto` - Type indicates that the system selects the target interface automatically during iSCSI boot.", "type": "string", "enum": [ "Static", "Auto" ], "default": "Static", "readOnly": true, "x-omitempty": true }, "InitiatorIpPool": { "$ref": "#/components/schemas/ippool.Pool.Relationship", "description": "A reference to a ippoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "IscsiAdapterPolicy": { "$ref": "#/components/schemas/vnic.IscsiAdapterPolicyInventory.Relationship", "description": "A reference to a vnicIscsiAdapterPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "PrimaryTargetPolicy": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory.Relationship", "description": "A reference to a vnicIscsiStaticTargetPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "SecondaryTargetPolicy": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory.Relationship", "description": "A reference to a vnicIscsiStaticTargetPolicyInventory resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.IscsiBootPolicyInventory.List": { "title": "List of 'vnic.IscsiBootPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiBootPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiBootPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiBootPolicyInventory" }, "nullable": true } } } ] }, "vnic.IscsiStaticTargetPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiStaticTargetPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiStaticTargetPolicy' resources.", "x-one-of-name": "vnic.IscsiStaticTargetPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiStaticTargetPolicy.Relationship": { "description": "A relationship to the 'vnic.IscsiStaticTargetPolicy' resource, or the expanded 'vnic.IscsiStaticTargetPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiStaticTargetPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiStaticTargetPolicy": { "title": "iSCSI Static Target", "description": "The IscsiStaticTargetPolicy object defines the parameters for connecting to specific iSCSI targets, ensuring reachability and correct configuration for iSCSI boot or storage access.\n####Purpose\nIscsiStaticTargetPolicy provides a standardized way to specify static iSCSI targets, including target names, IP addresses, ports, and associated LUN configurations.\n#### Key Concepts\n- **Target Specification:** Standardizes the definition of iSCSI targets for boot or data access.\n- **Policy Integration:** Used in conjunction with iSCSI boot policies for automated deployment.", "x-allOf-name": "vnic.IscsiStaticTargetPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiStaticTargetPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiStaticTargetPolicy" ], "default": "vnic.IscsiStaticTargetPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiStaticTargetPolicy" ], "default": "vnic.IscsiStaticTargetPolicy", "x-enum-as-string": true }, "IpAddress": { "description": "The IP address assigned to the iSCSI target.", "type": "string", "x-omitempty": true }, "IscsiIpType": { "description": "Type of the IP address requested for iSCSI vNIC - IPv4/IPv6.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "x-omitempty": true }, "Lun": { "description": "The LUN parameters associated with an iSCSI target.", "$ref": "#/components/schemas/vnic.Lun", "x-omitempty": true }, "Port": { "description": "The port associated with the iSCSI target.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 65535, "x-omitempty": true }, "TargetName": { "description": "Qualified Name (IQN) or Extended Unique Identifier (EUI) name of the iSCSI target.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.IscsiStaticTargetPolicy.List": { "title": "List of 'vnic.IscsiStaticTargetPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiStaticTargetPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiStaticTargetPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicy" }, "nullable": true } } } ] }, "vnic.IscsiStaticTargetPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.IscsiStaticTargetPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.IscsiStaticTargetPolicyInventory' resources.", "x-one-of-name": "vnic.IscsiStaticTargetPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.IscsiStaticTargetPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.IscsiStaticTargetPolicyInventory' resource, or the expanded 'vnic.IscsiStaticTargetPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.IscsiStaticTargetPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.IscsiStaticTargetPolicyInventory": { "title": "iSCSI Static Target", "description": "The IscsiStaticTargetPolicy object defines the parameters for connecting to specific iSCSI targets, ensuring reachability and correct configuration for iSCSI boot or storage access.\n####Purpose\nIscsiStaticTargetPolicy provides a standardized way to specify static iSCSI targets, including target names, IP addresses, ports, and associated LUN configurations.\n#### Key Concepts\n- **Target Specification:** Standardizes the definition of iSCSI targets for boot or data access.\n- **Policy Integration:** Used in conjunction with iSCSI boot policies for automated deployment.", "x-allOf-name": "vnic.IscsiStaticTargetPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.IscsiStaticTargetPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.IscsiStaticTargetPolicyInventory" ], "default": "vnic.IscsiStaticTargetPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.IscsiStaticTargetPolicyInventory" ], "default": "vnic.IscsiStaticTargetPolicyInventory", "x-enum-as-string": true }, "IpAddress": { "description": "The IP address assigned to the iSCSI target.", "type": "string", "readOnly": true, "x-omitempty": true }, "IscsiIpType": { "description": "Type of the IP address requested for iSCSI vNIC - IPv4/IPv6.\n* `IPv4` - IP V4 address type requested.\n* `IPv6` - IP V6 address type requested.", "type": "string", "enum": [ "IPv4", "IPv6" ], "default": "IPv4", "readOnly": true, "x-omitempty": true }, "Lun": { "description": "The LUN parameters associated with an iSCSI target.", "$ref": "#/components/schemas/vnic.Lun", "readOnly": true, "x-omitempty": true }, "Port": { "description": "The port associated with the iSCSI target.", "type": "integer", "format": "int64", "minimum": 1, "maximum": 65535, "readOnly": true, "x-omitempty": true }, "TargetName": { "description": "Qualified Name (IQN) or Extended Unique Identifier (EUI) name of the iSCSI target.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "readOnly": true, "x-omitempty": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.IscsiStaticTargetPolicyInventory.List": { "title": "List of 'vnic.IscsiStaticTargetPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.IscsiStaticTargetPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.IscsiStaticTargetPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.IscsiStaticTargetPolicyInventory" }, "nullable": true } } } ] }, "vnic.LanConnectivityPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.LanConnectivityPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.LanConnectivityPolicy' resources.", "x-one-of-name": "vnic.LanConnectivityPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.LanConnectivityPolicy.Relationship": { "description": "A relationship to the 'vnic.LanConnectivityPolicy' resource, or the expanded 'vnic.LanConnectivityPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.LanConnectivityPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.LanConnectivityPolicy": { "title": "LAN Connectivity", "description": "The LanConnectivityPolicy object defines the network resources and connection topology between servers and the LAN within Cisco systems. It abstracts the configuration of virtual network interfaces (vNICs), ensuring consistent device naming, optimized placement, and advanced features such as usNIC and VMQ for improved network performance.\n#### Purpose\nA LanConnectivityPolicy centralizes the management of LAN connectivity for servers by specifying how virtual interfaces are created and associated with network resources. It enables both automatic and custom placement of vNICs, supports the assignment of MAC addresses, and integrates with relevant network and adapter policies.\n#### Key Concepts\n- **Policy-Based Networking:** Facilitates consistent and scalable LAN connectivity across multiple servers.\n- **Integration with Network Policies:** Links to Ethernet network, QoS, and adapter policies for comprehensive configuration.\n- **Device Naming and Placement:** Supports consistent device naming and controls vNIC placement for optimal performance.", "x-allOf-name": "vnic.LanConnectivityPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.LanConnectivityPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.LanConnectivityPolicy" ], "default": "vnic.LanConnectivityPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.LanConnectivityPolicy" ], "default": "vnic.LanConnectivityPolicy", "x-enum-as-string": true }, "AzureQosEnabled": { "description": "Enabling AzureStack-Host QoS on an adapter allows the user to carve out traffic classes for RDMA traffic which ensures that a desired portion of the bandwidth is allocated to it.", "type": "boolean", "default": false, "x-omitempty": true }, "IqnAllocationType": { "description": "Allocation Type of iSCSI Qualified Name - Static/Pool/None.\n* `None` - Type indicates that there is no IQN associated to an interface.\n* `Static` - Type represents that static IQN is associated to an interface.\n* `Pool` - Type indicates that IQN value is sourced from an associated pool.", "type": "string", "enum": [ "None", "Static", "Pool" ], "default": "None", "x-omitempty": true }, "PlacementMode": { "description": "The mode used for placement of vNICs on network adapters. It can either be Auto or Custom.\n* `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user.\n* `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system.", "type": "string", "enum": [ "custom", "auto" ], "default": "custom", "x-omitempty": true }, "StaticIqnName": { "description": "User provided static iSCSI Qualified Name (IQN) for use as initiator identifiers by iSCSI vNICs in a Fabric Interconnect domain.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "x-omitempty": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "x-omitempty": true }, "EthIfs": { "description": "An array of relationships to vnicEthIf resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIf.Relationship" }, "nullable": true }, "IqnPool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true } } } ] }, "vnic.LanConnectivityPolicy.List": { "title": "List of 'vnic.LanConnectivityPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.LanConnectivityPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.LanConnectivityPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicy" }, "nullable": true } } } ] }, "vnic.LanConnectivityPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.LanConnectivityPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.LanConnectivityPolicyInventory' resources.", "x-one-of-name": "vnic.LanConnectivityPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.LanConnectivityPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.LanConnectivityPolicyInventory' resource, or the expanded 'vnic.LanConnectivityPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.LanConnectivityPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.LanConnectivityPolicyInventory": { "title": "LAN Connectivity", "description": "The LanConnectivityPolicy object defines the network resources and connection topology between servers and the LAN within Cisco systems. It abstracts the configuration of virtual network interfaces (vNICs), ensuring consistent device naming, optimized placement, and advanced features such as usNIC and VMQ for improved network performance.\n#### Purpose\nA LanConnectivityPolicy centralizes the management of LAN connectivity for servers by specifying how virtual interfaces are created and associated with network resources. It enables both automatic and custom placement of vNICs, supports the assignment of MAC addresses, and integrates with relevant network and adapter policies.\n#### Key Concepts\n- **Policy-Based Networking:** Facilitates consistent and scalable LAN connectivity across multiple servers.\n- **Integration with Network Policies:** Links to Ethernet network, QoS, and adapter policies for comprehensive configuration.\n- **Device Naming and Placement:** Supports consistent device naming and controls vNIC placement for optimal performance.", "x-allOf-name": "vnic.LanConnectivityPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.LanConnectivityPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.LanConnectivityPolicyInventory" ], "default": "vnic.LanConnectivityPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.LanConnectivityPolicyInventory" ], "default": "vnic.LanConnectivityPolicyInventory", "x-enum-as-string": true }, "AzureQosEnabled": { "description": "Enabling AzureStack-Host QoS on an adapter allows the user to carve out traffic classes for RDMA traffic which ensures that a desired portion of the bandwidth is allocated to it.", "type": "boolean", "default": false, "readOnly": true, "x-omitempty": true }, "IqnAllocationType": { "description": "Allocation Type of iSCSI Qualified Name - Static/Pool/None.\n* `None` - Type indicates that there is no IQN associated to an interface.\n* `Static` - Type represents that static IQN is associated to an interface.\n* `Pool` - Type indicates that IQN value is sourced from an associated pool.", "type": "string", "enum": [ "None", "Static", "Pool" ], "default": "None", "readOnly": true, "x-omitempty": true }, "PlacementMode": { "description": "The mode used for placement of vNICs on network adapters. It can either be Auto or Custom.\n* `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user.\n* `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system.", "type": "string", "enum": [ "custom", "auto" ], "default": "custom", "readOnly": true, "x-omitempty": true }, "StaticIqnName": { "description": "User provided static iSCSI Qualified Name (IQN) for use as initiator identifiers by iSCSI vNICs in a Fabric Interconnect domain.", "type": "string", "pattern": "^$|^(?:iqn\\.[0-9]{4}-[0-9]{2}(?:\\.[A-Za-z](?:[A-Za-z0-9\\-]*[A-Za-z0-9])?)+(?::.*)?|eui\\.[0-9A-Fa-f]{16})", "readOnly": true, "x-omitempty": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "readOnly": true, "x-omitempty": true }, "EthIfs": { "description": "An array of relationships to vnicEthIfInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.EthIfInventory.Relationship" }, "nullable": true, "readOnly": true }, "IqnPool": { "$ref": "#/components/schemas/iqnpool.Pool.Relationship", "description": "A reference to a iqnpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.LanConnectivityPolicyInventory.List": { "title": "List of 'vnic.LanConnectivityPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.LanConnectivityPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.LanConnectivityPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.LanConnectivityPolicyInventory" }, "nullable": true } } } ] }, "vnic.LanSettings.Response": { "description": "The response body of a HTTP GET request for the 'vnic.LanSettings' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.LanSettings' resources.", "x-one-of-name": "vnic.LanSettings.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.LanSettings.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.LanSettings": { "title": "LAN Settings", "description": "An internal MO to track the LAN settings that are applied to a server profile (like iQNLease).", "x-allOf-name": "vnic.LanSettings", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.LanSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.LanSettings" ], "default": "vnic.LanSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.LanSettings" ], "default": "vnic.LanSettings", "x-enum-as-string": true }, "IqnName": { "description": "Qualified Name (IQN) assigned to iSCSI vNICs in a Fabric Interconnect domain.", "type": "string", "readOnly": true, "x-omitempty": true }, "IqnLease": { "$ref": "#/components/schemas/iqnpool.Lease.Relationship", "description": "A reference to a iqnpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.LanSettings.List": { "title": "List of 'vnic.LanSettings' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.LanSettings' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.LanSettings' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.LanSettings" }, "nullable": true } } } ] }, "vnic.LcpStatus.Response": { "description": "The response body of a HTTP GET request for the 'vnic.LcpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.LcpStatus' resources.", "x-one-of-name": "vnic.LcpStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.LcpStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.LcpStatus": { "title": "LCP Status", "description": "An internal MO to check if a LCP can be deployed or not on a specific Server Profile.", "x-allOf-name": "vnic.LcpStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.LcpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.LcpStatus" ], "default": "vnic.LcpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.LcpStatus" ], "default": "vnic.LcpStatus", "x-enum-as-string": true }, "Reason": { "description": "The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure.", "type": "string", "x-omitempty": true }, "Status": { "description": "Indicates if the LCP is ready for Deploy or not.\n* `ok` - No issues with the LCP/SCP/VIF.\n* `error` - The LCP/SCP/VIF cannot be deployed due to error.\n* `validating` - Validation in progress for the LCP.", "type": "string", "enum": [ "ok", "error", "validating" ], "default": "ok", "x-omitempty": true }, "VnicInfo": { "type": "array", "items": { "description": "The status of all the vNICs in the LCP.", "$ref": "#/components/schemas/vnic.VifStatus", "x-omitempty": true }, "nullable": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.LcpStatus.List": { "title": "List of 'vnic.LcpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.LcpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.LcpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.LcpStatus" }, "nullable": true } } } ] }, "vnic.Lun": { "title": "Lun Interface", "description": "Lun specific parameters that will be part of a vNIC.", "x-allOf-name": "vnic.Lun", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.Lun', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.Lun" ], "default": "vnic.Lun", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.Lun" ], "default": "vnic.Lun", "x-enum-as-string": true }, "Bootable": { "description": "Specifies LUN is bootable.", "type": "boolean", "x-omitempty": true }, "LunId": { "description": "The Identifier of the LUN.", "type": "integer", "format": "int64", "minimum": 0, "x-omitempty": true } } } ] }, "vnic.NetFlowMonitorSession": { "title": "NetFlow Monitor Session", "description": "NetFlow monitoring configuration for the virtual NIC.", "x-allOf-name": "vnic.NetFlowMonitorSession", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.NetFlowMonitorSession', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.NetFlowMonitorSession" ], "default": "vnic.NetFlowMonitorSession", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.NetFlowMonitorSession" ], "default": "vnic.NetFlowMonitorSession", "x-enum-as-string": true }, "FlowDirection": { "description": "Direction of the flow to monitor (ingress, egress, or both).\n* `both` - Both direction for NetFlow monitor.\n* `rx` - Input direction for NetFlow monitor.\n* `tx` - Output direction for NetFlow monitor.", "type": "string", "enum": [ "both", "rx", "tx" ], "default": "both", "x-omitempty": true }, "MonitorName": { "description": "Name of the NetFlow monitor to use for this vNIC. The NetFlow monitor must be pre-configured on the Fabric Interconnects. It is configured as part of the NetFlow policy attached to the Fabric Switch Cluster profile.", "type": "string", "pattern": "^$|^[a-zA-Z0-9_.:-]{1,64}$", "x-omitempty": true } } } ] }, "vnic.NvgreSettings": { "title": "NVGRE Settings", "description": "Network Virtualization using Generic Routing Encapsulation Settings.", "x-allOf-name": "vnic.NvgreSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.NvgreSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.NvgreSettings" ], "default": "vnic.NvgreSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.NvgreSettings" ], "default": "vnic.NvgreSettings", "x-enum-as-string": true }, "Enabled": { "description": "Status of the Network Virtualization using Generic Routing Encapsulation on the virtual ethernet interface.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "vnic.PlacementSettings": { "title": "Placement Settings", "description": "Placement Settings for the virtual interface.", "x-allOf-name": "vnic.PlacementSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.PlacementSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.PlacementSettings" ], "default": "vnic.PlacementSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.PlacementSettings" ], "default": "vnic.PlacementSettings", "x-enum-as-string": true }, "AutoPciLink": { "description": "Enable or disable automatic assignment of the PCI Link in a dual-link adapter. This option applies only to 13xx series VICs that support dual-link. If enabled, the system determines the placement of the vNIC/vHBA on either of the PCI Links.", "type": "boolean", "default": false, "x-omitempty": true }, "AutoSlotId": { "description": "Enable or disable automatic assignment of the VIC slot ID. If enabled and the server has only one VIC, the same VIC is chosen for all the vNICs. If enabled and the server has multiple VICs, the vNIC/vHBA are deployed on the first VIC. The Slot ID determines the first VIC. MLOM is the first Slot ID and the ID increments to 2, 3, and so on.", "type": "boolean", "default": false, "x-omitempty": true }, "Id": { "description": "PCIe Slot where the VIC adapter is installed. Supported values are (1-15) and MLOM.", "type": "string", "pattern": "^$|^([1-9]|1[0-5]|MLOM)$", "x-omitempty": true }, "PciLink": { "description": "The PCI Link used as transport for the virtual interface. PCI Link is only applicable for select Cisco UCS VIC 1300 models (UCSC-PCIE-C40Q-03, UCSB-MLOM-40G-03, UCSB-VIC-M83-8P) that support two PCI links. The value, if specified, for any other VIC model will be ignored.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 1, "x-omitempty": true }, "PciLinkAssignmentMode": { "description": "If the autoPciLink is disabled, the user can either choose to place the vNICs manually or based on a policy.If the autoPciLink is enabled, it will be set to None.\n* `Custom` - The user needs to specify the PCI Link manually.\n* `Load-Balanced` - The system will uniformly distribute the interfaces across the PCI Links.\n* `None` - Assignment is not applicable and will be set when the AutoPciLink is set to true.", "type": "string", "enum": [ "Custom", "Load-Balanced", "None" ], "default": "Custom", "x-omitempty": true }, "SwitchId": { "description": "The fabric port to which the vNICs will be associated.\n* `None` - Fabric Id is not set to either A or B for the standalone case where the server is not connected to Fabric Interconnects. The value 'None' should be used.\n* `A` - Fabric A of the FI cluster.\n* `B` - Fabric B of the FI cluster.", "type": "string", "enum": [ "None", "A", "B" ], "default": "None", "x-omitempty": true }, "Uplink": { "description": "Adapter port on which the virtual interface will be created.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 3, "x-omitempty": true } } } ] }, "vnic.PlogiSettings": { "title": "Plogi Settings", "description": "Fibre Channel Plogi Settings.", "x-allOf-name": "vnic.PlogiSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.PlogiSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.PlogiSettings" ], "default": "vnic.PlogiSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.PlogiSettings" ], "default": "vnic.PlogiSettings", "x-enum-as-string": true }, "Retries": { "description": "The number of times that the system tries to log in to a port after the first failure.", "type": "integer", "format": "int64", "default": 8, "minimum": 0, "maximum": 255, "x-omitempty": true }, "Timeout": { "description": "The number of milliseconds that the system waits before it tries to log in again.", "type": "integer", "format": "int64", "default": 20000, "minimum": 1000, "maximum": 255000, "x-omitempty": true } } } ] }, "vnic.PtpSettings": { "title": "PTP Settings", "description": "Settings for Precision Time Protocol which can provide precise time of day information and time-stampted inputs, as well as scheduled and/or synchronized outputs for a variety of systems.", "x-allOf-name": "vnic.PtpSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.PtpSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.PtpSettings" ], "default": "vnic.PtpSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.PtpSettings" ], "default": "vnic.PtpSettings", "x-enum-as-string": true }, "Enabled": { "description": "Status of Precision Time Protocol (PTP) on the virtual ethernet interface. PTP can be enabled only on one vNIC on an adapter.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "vnic.RoceSettings": { "title": "RoCE Settings", "description": "Settings for RDMA over Converged Ethernet.", "x-allOf-name": "vnic.RoceSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.RoceSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.RoceSettings" ], "default": "vnic.RoceSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.RoceSettings" ], "default": "vnic.RoceSettings", "x-enum-as-string": true }, "ClassOfService": { "description": "The Class of Service for RoCE on this virtual interface.\n* `5` - RDMA CoS Service Level 5.\n* `1` - RDMA CoS Service Level 1.\n* `2` - RDMA CoS Service Level 2.\n* `4` - RDMA CoS Service Level 4.\n* `6` - RDMA CoS Service Level 6.", "type": "integer", "enum": [ 5, 1, 2, 4, 6 ], "default": 5, "x-omitempty": true }, "Enabled": { "description": "If enabled sets RDMA over Converged Ethernet (RoCE) on this virtual interface.", "type": "boolean", "x-omitempty": true }, "MemoryRegions": { "description": "The number of memory regions per adapter. Recommended value = integer power of 2.", "type": "integer", "format": "int64", "default": 131072, "minimum": 0, "maximum": 524288, "x-omitempty": true }, "QueuePairs": { "description": "The number of queue pairs per adapter. Recommended value = integer power of 2.", "type": "integer", "format": "int64", "default": 256, "minimum": 0, "maximum": 8192, "x-omitempty": true }, "ResourceGroups": { "description": "The number of resource groups per adapter. Recommended value = be an integer power of 2 greater than or equal to the number of CPU cores on the system for optimum performance.", "type": "integer", "format": "int64", "default": 2, "minimum": 0, "maximum": 128, "x-omitempty": true }, "Version": { "description": "Configure RDMA over Converged Ethernet (RoCE) version on the virtual interface. Only RoCEv1 is supported on Cisco VIC 13xx series adapters and only RoCEv2 is supported on Cisco VIC 14xx series adapters.\n* `1` - RDMA over Converged Ethernet Protocol Version 1.\n* `2` - RDMA over Converged Ethernet Protocol Version 2.", "type": "integer", "enum": [ 1, 2 ], "default": 1, "x-omitempty": true } } } ] }, "vnic.RssHashSettings": { "title": "RSS Hash Profile", "description": "The RSS Hash parameters help the traffic distribution across the Receive Queues based on the IP address (IPv4 or IPv6) and TCP Port numbers. These options help ensure that a single flow is directed to the same receive queue ensuring in-order delivery.", "x-allOf-name": "vnic.RssHashSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.RssHashSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.RssHashSettings" ], "default": "vnic.RssHashSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.RssHashSettings" ], "default": "vnic.RssHashSettings", "x-enum-as-string": true }, "Ipv4Hash": { "description": "When enabled, the IPv4 address is used for traffic distribution.", "type": "boolean", "default": true, "x-omitempty": true }, "Ipv6ExtHash": { "description": "When enabled, the IPv6 extensions are used for traffic distribution.", "type": "boolean", "default": false, "x-omitempty": true }, "Ipv6Hash": { "description": "When enabled, the IPv6 address is used for traffic distribution.", "type": "boolean", "default": true, "x-omitempty": true }, "TcpIpv4Hash": { "description": "When enabled, both the IPv4 address and TCP port number are used for traffic distribution.", "type": "boolean", "default": true, "x-omitempty": true }, "TcpIpv6ExtHash": { "description": "When enabled, both the IPv6 extensions and TCP port number are used for traffic distribution.", "type": "boolean", "default": false, "x-omitempty": true }, "TcpIpv6Hash": { "description": "When enabled, both the IPv6 address and TCP port number are used for traffic distribution.", "type": "boolean", "default": true, "x-omitempty": true }, "UdpIpv4Hash": { "description": "When enabled, both the IPv4 address and UDP port number are used for traffic distribution.", "type": "boolean", "default": false, "x-omitempty": true }, "UdpIpv6Hash": { "description": "When enabled, both the IPv6 address and UDP port number are used for traffic distribution.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "vnic.SanConnectivityPolicy.Response": { "description": "The response body of a HTTP GET request for the 'vnic.SanConnectivityPolicy' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.SanConnectivityPolicy' resources.", "x-one-of-name": "vnic.SanConnectivityPolicy.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.SanConnectivityPolicy.Relationship": { "description": "A relationship to the 'vnic.SanConnectivityPolicy' resource, or the expanded 'vnic.SanConnectivityPolicy' resource, or the 'null' value.", "x-one-of-name": "vnic.SanConnectivityPolicy.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.SanConnectivityPolicy": { "title": "SAN Connectivity", "description": "The SanConnectivityPolicy object governs the connectivity between servers and the storage area network (SAN). It abstracts the configuration of virtual host bus adapters (vHBAs), ensuring streamlined storage access and management.\n#### Purpose\nSanConnectivityPolicy centralizes the definition and management of SAN connections, handling assignment of WWN addresses, zoning, and integration with storage-related policies.\n#### Key Concepts\n- **Centralized SAN Management:** Simplifies and standardizes SAN connectivity for server environments.\n- **vHBA Configuration:** Manages the lifecycle and settings of virtual HBAs.\n- **Policy Integration:** Connects to WWN pools and storage zoning policies for comprehensive SAN.", "x-allOf-name": "vnic.SanConnectivityPolicy", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.SanConnectivityPolicy', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.SanConnectivityPolicy" ], "default": "vnic.SanConnectivityPolicy", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.SanConnectivityPolicy" ], "default": "vnic.SanConnectivityPolicy", "x-enum-as-string": true }, "PlacementMode": { "description": "The mode used for placement of vNICs on network adapters. It can either be Auto or Custom.\n* `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user.\n* `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system.", "type": "string", "enum": [ "custom", "auto" ], "default": "custom", "x-omitempty": true }, "StaticWwnnAddress": { "description": "The WWNN address for the server node must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.\nAllowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.\nTo ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "x-omitempty": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "x-omitempty": true }, "WwnnAddressType": { "description": "Type of allocation selected to assign a WWNN address for the server node.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "x-omitempty": true }, "FcIfs": { "description": "An array of relationships to vnicFcIf resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIf.Relationship" }, "nullable": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true }, "Profiles": { "deprecated": true, "x-sunset": "2028-03-01", "description": "An array of relationships to policyAbstractConfigProfile resources.", "type": "array", "items": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship" }, "nullable": true }, "WwnnPool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.SanConnectivityPolicy.List": { "title": "List of 'vnic.SanConnectivityPolicy' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.SanConnectivityPolicy' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.SanConnectivityPolicy' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicy" }, "nullable": true } } } ] }, "vnic.SanConnectivityPolicyInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.SanConnectivityPolicyInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.SanConnectivityPolicyInventory' resources.", "x-one-of-name": "vnic.SanConnectivityPolicyInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.SanConnectivityPolicyInventory.Relationship": { "description": "A relationship to the 'vnic.SanConnectivityPolicyInventory' resource, or the expanded 'vnic.SanConnectivityPolicyInventory' resource, or the 'null' value.", "x-one-of-name": "vnic.SanConnectivityPolicyInventory.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.SanConnectivityPolicyInventory": { "title": "SAN Connectivity", "description": "The SanConnectivityPolicy object governs the connectivity between servers and the storage area network (SAN). It abstracts the configuration of virtual host bus adapters (vHBAs), ensuring streamlined storage access and management.\n#### Purpose\nSanConnectivityPolicy centralizes the definition and management of SAN connections, handling assignment of WWN addresses, zoning, and integration with storage-related policies.\n#### Key Concepts\n- **Centralized SAN Management:** Simplifies and standardizes SAN connectivity for server environments.\n- **vHBA Configuration:** Manages the lifecycle and settings of virtual HBAs.\n- **Policy Integration:** Connects to WWN pools and storage zoning policies for comprehensive SAN.", "x-allOf-name": "vnic.SanConnectivityPolicyInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicyInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.SanConnectivityPolicyInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.SanConnectivityPolicyInventory" ], "default": "vnic.SanConnectivityPolicyInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.SanConnectivityPolicyInventory" ], "default": "vnic.SanConnectivityPolicyInventory", "x-enum-as-string": true }, "PlacementMode": { "description": "The mode used for placement of vNICs on network adapters. It can either be Auto or Custom.\n* `custom` - The placement of the vNICs / vHBAs on network adapters is manually chosen by the user.\n* `auto` - The placement of the vNICs / vHBAs on network adapters is automatically determined by the system.", "type": "string", "enum": [ "custom", "auto" ], "default": "custom", "readOnly": true, "x-omitempty": true }, "StaticWwnnAddress": { "description": "The WWNN address for the server node must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx.\nAllowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF.\nTo ensure uniqueness of WWN's in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "TargetPlatform": { "description": "The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.\n* `Standalone` - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected.\n* `FIAttached` - Servers which are connected to a Fabric Interconnect that is managed by Intersight.\n* `UnifiedEdgeServer` - Unified Edge sleds that is managed by Intersight.", "type": "string", "enum": [ "Standalone", "FIAttached", "UnifiedEdgeServer" ], "default": "Standalone", "readOnly": true, "x-omitempty": true }, "WwnnAddressType": { "description": "Type of allocation selected to assign a WWNN address for the server node.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "FcIfs": { "description": "An array of relationships to vnicFcIfInventory resources.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.FcIfInventory.Relationship" }, "nullable": true, "readOnly": true }, "TargetMo": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo.Relationship", "description": "A reference to a moBaseMo resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WwnnPool": { "$ref": "#/components/schemas/fcpool.Pool.Relationship", "description": "A reference to a fcpoolPool resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.SanConnectivityPolicyInventory.List": { "title": "List of 'vnic.SanConnectivityPolicyInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.SanConnectivityPolicyInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.SanConnectivityPolicyInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.SanConnectivityPolicyInventory" }, "nullable": true } } } ] }, "vnic.SanSettings.Response": { "description": "The response body of a HTTP GET request for the 'vnic.SanSettings' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.SanSettings' resources.", "x-one-of-name": "vnic.SanSettings.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.SanSettings.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.SanSettings": { "title": "SAN Settings", "description": "An internal MO to track the SAN settings that are applied to a server profile (like WWNN).", "x-allOf-name": "vnic.SanSettings", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractPolicy" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.SanSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.SanSettings" ], "default": "vnic.SanSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.SanSettings" ], "default": "vnic.SanSettings", "x-enum-as-string": true }, "OldInfo": { "description": "San Settings that need to be preserved during ID preservation.", "$ref": "#/components/schemas/vnic.SanSettingsOldInfo", "readOnly": true, "x-omitempty": true }, "Wwnn": { "description": "The WWNN address that is assigned to the server node based on the wwn pool that has been assigned in the SAN Connectivity Policy.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true }, "WwnnLease": { "$ref": "#/components/schemas/fcpool.Lease.Relationship", "description": "A reference to a fcpoolLease resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vnic.SanSettings.List": { "title": "List of 'vnic.SanSettings' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.SanSettings' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.SanSettings' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.SanSettings" }, "nullable": true } } } ] }, "vnic.SanSettingsOldInfo": { "title": "Old San Settings", "description": "Old San Settings that need to be preserved.", "x-allOf-name": "vnic.SanSettingsOldInfo", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.SanSettingsOldInfo', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.SanSettingsOldInfo" ], "default": "vnic.SanSettingsOldInfo", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.SanSettingsOldInfo" ], "default": "vnic.SanSettingsOldInfo", "x-enum-as-string": true }, "Wwnn": { "description": "The WWNN address that is assigned to the server node based on the wwn pool that has been assigned in the SAN Connectivity Policy.", "type": "string", "pattern": "^$|((^20|5[0-9a-fA-F]{1}):([0-9a-fA-F]{2}:){6}([0-9a-fA-F]{2})$)", "readOnly": true, "x-omitempty": true }, "WwnnAddressType": { "description": "Type of allocation selected to assign a WWNN address for the server node.\n* `POOL` - The user selects a pool from which the mac/wwn address will be leased for the Virtual Interface.\n* `STATIC` - The user assigns a static mac/wwn address for the Virtual Interface.", "type": "string", "enum": [ "POOL", "STATIC" ], "default": "POOL", "readOnly": true, "x-omitempty": true }, "WwnnLease": { "description": "One of the WWNN Addresses that is leased to the vHBA.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "readOnly": true, "x-omitempty": true }, "WwnnPool": { "description": "The WWN pool used for assigning the WWNN address to the server node.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef", "x-omitempty": true } } } ] }, "vnic.ScpStatus.Response": { "description": "The response body of a HTTP GET request for the 'vnic.ScpStatus' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.ScpStatus' resources.", "x-one-of-name": "vnic.ScpStatus.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.ScpStatus.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.ScpStatus": { "title": "SCP Status", "description": "An internal MO to check if a SCP can be deployed or not on a specific Server Profile.", "x-allOf-name": "vnic.ScpStatus", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.ScpStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.ScpStatus" ], "default": "vnic.ScpStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.ScpStatus" ], "default": "vnic.ScpStatus", "x-enum-as-string": true }, "Reason": { "description": "The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure.", "type": "string", "x-omitempty": true }, "Status": { "description": "Indicates if the LCP is ready for Deploy or not.\n* `ok` - No issues with the LCP/SCP/VIF.\n* `error` - The LCP/SCP/VIF cannot be deployed due to error.\n* `validating` - Validation in progress for the LCP.", "type": "string", "enum": [ "ok", "error", "validating" ], "default": "ok", "x-omitempty": true }, "VhbaInfo": { "type": "array", "items": { "description": "The status of all the vHBAs in the LCP.", "$ref": "#/components/schemas/vnic.VifStatus", "x-omitempty": true }, "nullable": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.ScpStatus.List": { "title": "List of 'vnic.ScpStatus' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.ScpStatus' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.ScpStatus' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.ScpStatus" }, "nullable": true } } } ] }, "vnic.ScsiQueueSettings": { "title": "SCSI Queue Settings", "description": "SCSI Queue resource settings.", "x-allOf-name": "vnic.ScsiQueueSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.ScsiQueueSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.ScsiQueueSettings" ], "default": "vnic.ScsiQueueSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.ScsiQueueSettings" ], "default": "vnic.ScsiQueueSettings", "x-enum-as-string": true }, "Count": { "description": "The number of SCSI I/O queue resources the system should allocate.", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 245, "x-omitempty": true }, "RingSize": { "description": "The number of descriptors in each SCSI I/O queue.", "type": "integer", "format": "int64", "default": 512, "minimum": 64, "maximum": 512, "x-omitempty": true } } } ] }, "vnic.ServiceEthIf.Response": { "description": "The response body of a HTTP GET request for the 'vnic.ServiceEthIf' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.ServiceEthIf' resources.", "x-one-of-name": "vnic.ServiceEthIf.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.ServiceEthIf.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.ServiceEthIf": { "title": "Service Virtual Ethernet Interface", "description": "Service Virtual Ethernet Interface is created on each adapter to export netflow records to the collector via the Fabric Interconnect.", "x-allOf-name": "vnic.ServiceEthIf", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.ServiceEthIf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.ServiceEthIf" ], "default": "vnic.ServiceEthIf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.ServiceEthIf" ], "default": "vnic.ServiceEthIf", "x-enum-as-string": true }, "AdapterId": { "description": "Adapter Information for server.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the service virtual ethernet interface.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "The Vif Id should be same as the channel number of the vethernet created on switch in order to set up the data path. The property is applicable only for Fabric Interconnect attached servers where a vethernet is created on the switch for every vNIC.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Profile": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractConfigProfile.Relationship", "description": "A reference to a policyAbstractConfigProfile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.ServiceEthIf.List": { "title": "List of 'vnic.ServiceEthIf' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.ServiceEthIf' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.ServiceEthIf' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.ServiceEthIf" }, "nullable": true } } } ] }, "vnic.ServiceEthIfInventory.Response": { "description": "The response body of a HTTP GET request for the 'vnic.ServiceEthIfInventory' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.ServiceEthIfInventory' resources.", "x-one-of-name": "vnic.ServiceEthIfInventory.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.ServiceEthIfInventory.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.ServiceEthIfInventory": { "title": "Service Virtual Ethernet Interface", "description": "Service Virtual Ethernet Interface is created on each adapter to export netflow records to the collector via the Fabric Interconnect.", "x-allOf-name": "vnic.ServiceEthIfInventory", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/policy.AbstractInventory" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.ServiceEthIfInventory', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.ServiceEthIfInventory" ], "default": "vnic.ServiceEthIfInventory", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.ServiceEthIfInventory" ], "default": "vnic.ServiceEthIfInventory", "x-enum-as-string": true }, "AdapterId": { "description": "Adapter Information for server.", "type": "string", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the service virtual ethernet interface.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "readOnly": true, "x-omitempty": true }, "OverriddenList": { "type": "array", "items": { "description": "The list of properties in the derived MO which override the attached template properties.", "type": "string", "readOnly": true, "x-omitempty": true }, "nullable": true }, "Placement": { "description": "Placement Settings for the virtual interface.", "$ref": "#/components/schemas/vnic.PlacementSettings", "readOnly": true, "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action to the current derived object from its source template (syncOne).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync with template action, there can be two action parameters-\nname-SyncType, value-SyncOne.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncErrors": { "type": "array", "items": { "description": "The list of errors encountered when the sync action was executed.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.SyncError", "readOnly": true, "x-omitempty": true }, "nullable": true }, "TemplateSyncStatus": { "description": "The sync status of the current MO wrt the attached Template MO.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "VifId": { "description": "The Vif Id should be same as the channel number of the vethernet created on switch in order to set up the data path. The property is applicable only for Fabric Interconnect attached servers where a vethernet is created on the switch for every vNIC.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true } } } ] }, "vnic.ServiceEthIfInventory.List": { "title": "List of 'vnic.ServiceEthIfInventory' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.ServiceEthIfInventory' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.ServiceEthIfInventory' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.ServiceEthIfInventory" }, "nullable": true } } } ] }, "vnic.SriovSettings": { "title": "Single Root Input Output Virtualization Settings", "description": "Single Root Input Output Virtualization Settings that enable one physical ethernet socket to appear as multiple NICs to the hypervisor.", "x-allOf-name": "vnic.SriovSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.SriovSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.SriovSettings" ], "default": "vnic.SriovSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.SriovSettings" ], "default": "vnic.SriovSettings", "x-enum-as-string": true }, "CompCountPerVf": { "description": "Completion Queue resources per Virtual Function (VF).", "type": "integer", "format": "int64", "default": 5, "minimum": 1, "maximum": 16, "x-omitempty": true }, "Enabled": { "description": "If enabled, sets Single Root Input Output Virtualization (SR-IOV) on this vNIC.", "type": "boolean", "x-omitempty": true }, "IntCountPerVf": { "description": "Interrupt Count resources per Virtual Function (VF).", "type": "integer", "format": "int64", "default": 8, "minimum": 1, "maximum": 16, "x-omitempty": true }, "RxCountPerVf": { "description": "Receive Queue resources per Virtual Function (VF).", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 8, "x-omitempty": true }, "TxCountPerVf": { "description": "Transmit Queue resources per Virtual Function (VF).", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 8, "x-omitempty": true }, "VfCount": { "description": "Number of Virtual Functions (VF) to be created for this vNIC. Valid values are 1 to 64 when SR-IOV is enabled.", "type": "integer", "format": "int64", "default": 64, "minimum": 1, "maximum": 64, "x-omitempty": true } } } ] }, "vnic.TcpOffloadSettings": { "title": "TCP Offload", "description": "The TCP offload settings decide whether to offload the TCP related network functions from the CPU to the network hardware or not. These options help reduce the CPU overhead and increase the network throughput.", "x-allOf-name": "vnic.TcpOffloadSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.TcpOffloadSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.TcpOffloadSettings" ], "default": "vnic.TcpOffloadSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.TcpOffloadSettings" ], "default": "vnic.TcpOffloadSettings", "x-enum-as-string": true }, "LargeReceive": { "description": "Enables the reassembly of segmented packets in hardware before sending them to the CPU.", "type": "boolean", "default": true, "x-omitempty": true }, "LargeSend": { "description": "Enables the CPU to send large packets to the hardware for segmentation.", "type": "boolean", "default": true, "x-omitempty": true }, "RxChecksum": { "description": "When enabled, the CPU sends all packet checksums to the hardware for validation.", "type": "boolean", "default": true, "x-omitempty": true }, "TxChecksum": { "description": "When enabled, the CPU sends all packets to the hardware so that the checksum can be calculated.", "type": "boolean", "default": true, "x-omitempty": true } } } ] }, "vnic.UsnicSettings": { "title": "USNIC Settings", "description": "User Space NIC Settings that enable low-latency and higher throughput by bypassing the kernel layer when sending/receiving packets.", "x-allOf-name": "vnic.UsnicSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.UsnicSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.UsnicSettings" ], "default": "vnic.UsnicSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.UsnicSettings" ], "default": "vnic.UsnicSettings", "x-enum-as-string": true }, "Cos": { "description": "Class of Service to be used for traffic on the usNIC.", "type": "integer", "format": "int64", "default": 5, "minimum": 0, "maximum": 6, "x-omitempty": true }, "Count": { "description": "Number of usNIC interfaces to be created. When usNIC is enabled, the valid values are from 1 to 225. When usNIC is disabled, the default value is 0.", "type": "integer", "format": "int64", "minimum": 0, "maximum": 225, "x-omitempty": true }, "UsnicAdapterPolicy": { "description": "Ethernet Adapter policy to be associated with the usNICs.", "type": "string", "x-omitempty": true } } } ] }, "vnic.VhbaTemplate.Response": { "description": "The response body of a HTTP GET request for the 'vnic.VhbaTemplate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.VhbaTemplate' resources.", "x-one-of-name": "vnic.VhbaTemplate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.VhbaTemplate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.VhbaTemplate.Relationship": { "description": "A relationship to the 'vnic.VhbaTemplate' resource, or the expanded 'vnic.VhbaTemplate' resource, or the 'null' value.", "x-one-of-name": "vnic.VhbaTemplate.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.VhbaTemplate" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.VhbaTemplate": { "title": "vHBA template", "description": "The vHBA template consists of the common vHBA configuration, which can be reused across multiple vHBAs. vHBAs can be created from the template using the Derive operation. Additionally, an existing vHBA can be attached to a template to use the configuration set in the template.\nTo derive vHBAs from a vHBA template, you must use the asynchronous /v1/bulk/MoCloners bulk API.\nDeriving vHBAs from a vHBA Template\nURL: /v1/bulk/MoCloners\nMethod: POST\nHeaders:\n - Key: \"prefer\"\n Value: \"respond-async\"\nBody: >\n {\n \"Sources\": [\n {\n \"Moid\": \"xxxx\",\n \"ObjectType\": \"vnic.VhbaTemplate\"\n }\n ],\n \"Targets\": [\n {\n \"Name\": \"test-vh2\",\n \"SanConnectivityPolicy\": \"aaaaa\",\n \"ObjectType\": \"vnic.FcIf\"\n }\n ],\n \"WorkflowNameSuffix\": \"Derive vHBA from a Template\",\n \"Organization\": {\n \"Moid\": \"oooo\",\n \"ObjectType\": \"organization.Organization\"\n }\n}\nThe API response includes the \"AsyncResult\"->bulk.Result MO reference. API clients must poll the bulk.Result MO to monitor the status of the operation.\nThe bulk.Result object also includes a reference to a monitoring workflow, which is accessible from the 'Requests' tab in the UI.\nManaging Template Updates\nWhen the vHBA template is updated, the system initiates an automatic call to the /v1/bulk/MoMergers API to synchronize the template changes to all derived vHBA instances asynchronously. The status of the sync operation can be obtained by performing a query on vnic EthIf MO -\n$filter=SrcTemplate.Moid eq 'xxx'&$apply=groupby ( (TemplateSyncStatus), aggregate ($count as count))\nOverride Option for vHBA Templates\nWhen enabled, this feature allows the configuration of the derived vHBA to override the configuration available in the template during vHBA create or update.\nYou can query the list of overridable properties for a vHBA template from the Template Catalog. Use the following catalog API query:\nURL: /v1/capability/TemplateCatalogs\nQuery: $filter= (Name eq \u2018VhbaTemplate\u2019)&$select=AllowedOverrideList\nOnce a property is overridden on a derived vHBA, it will be added to the \u2018OverriddenList\u2019 property on the vnic FcIf MO.\nURL: /v1/vnic/FcIfs\nQuery: $select=SrcTemplate, OverriddenList\nWhen override is disabled on the template, derived vHBA will have same configuration as the template.", "x-allOf-name": "vnic.VhbaTemplate", "allOf": [ { "$ref": "#/components/schemas/vnic.BaseFcIf" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VhbaTemplate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VhbaTemplate" ], "default": "vnic.VhbaTemplate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VhbaTemplate" ], "default": "vnic.VhbaTemplate", "x-enum-as-string": true }, "Description": { "description": "Description of the vHBA template.", "type": "string", "x-omitempty": true }, "EnableOverride": { "description": "When enabled, the configuration of the derived instances may override the template configuration.", "type": "boolean", "x-omitempty": true }, "Name": { "description": "Name of the vHBA template.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "x-omitempty": true }, "PeerVhbaName": { "description": "Name of the peer vHBA which belongs to the peer FI.", "type": "string", "x-omitempty": true }, "ScpUsageCount": { "description": "The count of the San Connectivity Policies using vHBA template.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "SwitchId": { "description": "The fabric port to which the vHBAs will be associated.\n* `None` - Fabric Id is not set to either A or B for the standalone case where the server is not connected to Fabric Interconnects. The value 'None' should be used.\n* `A` - Fabric A of the FI cluster.\n* `B` - Fabric B of the FI cluster.", "type": "string", "enum": [ "None", "A", "B" ], "default": "None", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action from the current template only to failed objects (syncFailed).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync template action, there can be two action parameters-\nname-SyncType, value-SyncFailed.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "UpdateStatus": { "description": "The template sync status with all derived objects.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "UsageCount": { "description": "The number of objects derived from a Template MO instance.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.VhbaTemplate.List": { "title": "List of 'vnic.VhbaTemplate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.VhbaTemplate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.VhbaTemplate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.VhbaTemplate" }, "nullable": true } } } ] }, "vnic.VifIdPool.Response": { "description": "The response body of a HTTP GET request for the 'vnic.VifIdPool' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.VifIdPool' resources.", "x-one-of-name": "vnic.VifIdPool.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.VifIdPool.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.VifIdPool": { "title": "Vnic:Vif Id Pool", "description": "Identifier pool that generates a unique identity to be used for provisioning the virtual path between the vethernet / vfc and the corresponding vNIC / vHBA on the adapter.", "x-allOf-name": "vnic.VifIdPool", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VifIdPool', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VifIdPool" ], "default": "vnic.VifIdPool", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VifIdPool" ], "default": "vnic.VifIdPool", "x-enum-as-string": true }, "GapAvailableIds": { "type": "array", "items": { "description": "Used to store any freed up IDs between 0 and 'nextAvailId'.", "type": "integer", "format": "int64", "x-omitempty": true }, "nullable": true }, "NextAvailableId": { "description": "Shows the next available channel number ID to be allocated for a vNIC.", "type": "integer", "format": "int64", "x-omitempty": true }, "NetworkElement": { "$ref": "intersight-fabric-v3-1.0.11-20260807064027971.json#/components/schemas/network.Element.Relationship", "description": "A reference to a networkElement resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline." } } } ] }, "vnic.VifIdPool.List": { "title": "List of 'vnic.VifIdPool' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.VifIdPool' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.VifIdPool' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.VifIdPool" }, "nullable": true } } } ] }, "vnic.VifStatus": { "title": "vNIC / vHBA Status", "description": "The status of a vNIC or vHBA.", "x-allOf-name": "vnic.VifStatus", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VifStatus', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VifStatus" ], "default": "vnic.VifStatus", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VifStatus" ], "default": "vnic.VifStatus", "x-enum-as-string": true }, "Name": { "description": "Name of the vNIC for which the status is reported.", "type": "string", "x-omitempty": true }, "Reason": { "description": "The reason for the status - it will be empty if status is ok or validating. If error, it will have the appropriate message indicating the reason for failure.", "type": "string", "x-omitempty": true }, "Status": { "description": "Indicates if the vNIC / vHBA is ready for deploy or not.\n* `ok` - No issues with the LCP/SCP/VIF.\n* `error` - The LCP/SCP/VIF cannot be deployed due to error.\n* `validating` - Validation in progress for the LCP.", "type": "string", "enum": [ "ok", "error", "validating" ], "default": "ok", "x-omitempty": true } } } ] }, "vnic.VlanSettings": { "title": "VLAN Settings", "description": "VLAN configuration for the virtual interface.", "x-allOf-name": "vnic.VlanSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VlanSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VlanSettings" ], "default": "vnic.VlanSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VlanSettings" ], "default": "vnic.VlanSettings", "x-enum-as-string": true }, "AllowedVlans": { "description": "Allowed VLAN IDs of the virtual interface.", "type": "string", "pattern": "^$|^((\\d+\\-\\d+)|(\\d+))(,((\\d+\\-\\d+)|(\\d+)))*$", "x-omitempty": true }, "DefaultVlan": { "description": "Native VLAN ID of the virtual interface or the corresponding vethernet on the peer Fabric Interconnect to which the virtual interface is connected. Setting the ID to 0 will not associate any native VLAN to the traffic on the virtual interface.", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 4094, "x-omitempty": true }, "Mode": { "description": "Option to determine if the port can carry single VLAN (Access) or multiple VLANs (Trunk) traffic.\n* `ACCESS` - An access port carries traffic only for a single VLAN on the interface.\n* `TRUNK` - A trunk port can have two or more VLANs configured on the interface. It can carry traffic for several VLANs simultaneously.", "type": "string", "enum": [ "ACCESS", "TRUNK" ], "default": "ACCESS", "x-omitempty": true }, "QinqEnabled": { "description": "Enable QinQ (802.1Q-in-802.1Q) Tunneling on the vNIC.", "type": "boolean", "default": false, "x-omitempty": true }, "QinqVlan": { "description": "When activating VIC QinQ (802.1Q-in-802.1Q) Tunneling, a particular VLAN ID is set. In Access VLAN mode, this QinQ VLAN ID is established as the default VLAN.", "type": "integer", "format": "int64", "default": 2, "minimum": 2, "maximum": 4093, "x-omitempty": true } } } ] }, "vnic.VmqSettings": { "title": "VMQ Settings", "description": "Virtual Machine Queue Settings for the virtual interface that allow efficient transfer of network traffic to the guest OS.", "x-allOf-name": "vnic.VmqSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VmqSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VmqSettings" ], "default": "vnic.VmqSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VmqSettings" ], "default": "vnic.VmqSettings", "x-enum-as-string": true }, "Enabled": { "description": "Enables VMQ feature on the virtual interface.", "type": "boolean", "default": false, "x-omitempty": true }, "MultiQueueSupport": { "description": "Enables Virtual Machine Multi-Queue feature on the virtual interface. VMMQ allows configuration of multiple I/O queues for a single VM and thus distributes traffic across multiple CPU cores in a VM.", "type": "boolean", "default": false, "x-omitempty": true }, "NumInterrupts": { "description": "The number of interrupt resources to be allocated. Recommended value is the number of CPU threads or logical processors available in the server.", "type": "integer", "format": "int64", "default": 16, "minimum": 1, "maximum": 514, "x-omitempty": true }, "NumSubVnics": { "description": "The number of sub vNICs to be created.", "type": "integer", "format": "int64", "default": 64, "minimum": 0, "maximum": 64, "x-omitempty": true }, "NumVmqs": { "description": "The number of hardware Virtual Machine Queues to be allocated. The number of VMQs per adapter must be one more than the maximum number of VM NICs.", "type": "integer", "format": "int64", "default": 4, "minimum": 1, "maximum": 128, "x-omitempty": true }, "VmmqAdapterPolicy": { "description": "Ethernet Adapter policy to be associated with the Sub vNICs. The Transmit Queue and Receive Queue resource value of VMMQ adapter policy should be greater than or equal to the configured number of sub vNICs.", "type": "string", "x-omitempty": true } } } ] }, "vnic.VnicTemplate.Response": { "description": "The response body of a HTTP GET request for the 'vnic.VnicTemplate' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vnic.VnicTemplate' resources.", "x-one-of-name": "vnic.VnicTemplate.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vnic.VnicTemplate.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vnic.VnicTemplate.Relationship": { "description": "A relationship to the 'vnic.VnicTemplate' resource, or the expanded 'vnic.VnicTemplate' resource, or the 'null' value.", "x-one-of-name": "vnic.VnicTemplate.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vnic.VnicTemplate" } ], "discriminator": { "propertyName": "ClassId" } }, "vnic.VnicTemplate": { "title": "vNIC template", "description": "The VnicTemplate object encapsulates a reusable template for vNIC configuration. It standardizes the creation and management of multiple vNICs with consistent settings.\n#### Purpose\nA VnicTemplate simplifies and accelerates the deployment of standardized vNIC configurations across servers. It allows for the derivation of new vNICs from a common template and supports synchronization and property overrides to accommodate evolving requirements.\n#### Key Concepts\n- **Reusability:** Enables the rapid creation of vNICs with predefined settings.\n- **Template-Driven Management:** Supports synchronization of template changes to derived objects.\n- **Override Mechanism:** Provides flexibility to override specific properties as needed.", "x-allOf-name": "vnic.VnicTemplate", "allOf": [ { "$ref": "#/components/schemas/vnic.BaseEthIf" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VnicTemplate', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VnicTemplate" ], "default": "vnic.VnicTemplate", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VnicTemplate" ], "default": "vnic.VnicTemplate", "x-enum-as-string": true }, "Description": { "description": "Description of the vNIC template.", "type": "string", "x-omitempty": true }, "EnableOverride": { "description": "When enabled, the configuration of the derived instances may override the template configuration.", "type": "boolean", "x-omitempty": true }, "LcpUsageCount": { "description": "The count of the Lan Connectivity Policies using vNIC template.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Name": { "description": "Name of the vNIC template.", "type": "string", "pattern": "^[a-zA-Z0-9-._:]+$", "maxLength": 31, "x-omitempty": true }, "NetFlowMonitorSessions": { "type": "array", "items": { "description": "Netflow monitors on vNIC. The maximum supported monitors per vNIC is 2. The NetFlow monitor must be pre-configured on the Fabric Interconnects. It is configured as part of the NetFlow policy attached to the Fabric Switch Cluster profile.", "$ref": "#/components/schemas/vnic.NetFlowMonitorSession", "x-omitempty": true }, "nullable": true }, "PeerVnicName": { "description": "Name of the peer vNIC which belongs to the peer FI.", "type": "string", "x-omitempty": true }, "SwitchId": { "description": "The fabric port to which the vNICs will be associated.\n* `None` - Fabric Id is not set to either A or B for the standalone case where the server is not connected to Fabric Interconnects. The value 'None' should be used.\n* `A` - Fabric A of the FI cluster.\n* `B` - Fabric B of the FI cluster.", "type": "string", "enum": [ "None", "A", "B" ], "default": "None", "x-omitempty": true }, "TemplateActions": { "type": "array", "items": { "description": "The user-initiated actions that are executed in an asynchronous way. You can schedule actions like sync or deploy.\nFor example, you can schedule sync action from the current template only to failed objects (syncFailed).\nAction parameters are used to specify any custom settings related to each action. It is a collection of key:value pairs.\nFor example, in case of sync template action, there can be two action parameters-\nname-SyncType, value-SyncFailed.\nname-SyncTimer, value-time in seconds.", "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/motemplate.ActionEntry", "x-omitempty": true }, "nullable": true }, "UpdateStatus": { "description": "The template sync status with all derived objects.\n* `None` - The Enum value represents that the object is not attached to any template.\n* `OK` - The Enum value represents that the object values are in sync with attached template.\n* `Scheduled` - The Enum value represents that the object sync from attached template is scheduled from template.\n* `InProgress` - The Enum value represents that the object sync with the attached template is in progress.\n* `OutOfSync` - The Enum value represents that the object values are not in sync with attached template.", "type": "string", "enum": [ "None", "OK", "Scheduled", "InProgress", "OutOfSync" ], "default": "None", "readOnly": true, "x-omitempty": true }, "UsageCount": { "description": "The number of objects derived from a Template MO instance.", "type": "integer", "format": "int64", "readOnly": true, "x-omitempty": true }, "Organization": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/organization.Organization.Relationship", "description": "A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "x-createOnly": true } } } ] }, "vnic.VnicTemplate.List": { "title": "List of 'vnic.VnicTemplate' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vnic.VnicTemplate' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vnic.VnicTemplate' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vnic.VnicTemplate" }, "nullable": true } } } ] }, "vnic.VsanSettings": { "title": "VSAN Settings", "description": "VSAN configuration for the virtual interface.", "x-allOf-name": "vnic.VsanSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VsanSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VsanSettings" ], "default": "vnic.VsanSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VsanSettings" ], "default": "vnic.VsanSettings", "x-enum-as-string": true }, "DefaultVlanId": { "description": "Default VLAN of the virtual interface in Standalone Rack server. Setting the value to 0 is equivalent to None and will not associate any Default VLAN to the traffic on the virtual interface (0-4094).", "type": "integer", "format": "int64", "default": 0, "minimum": 0, "maximum": 4094, "x-omitempty": true }, "Id": { "description": "VSAN ID of the virtual interface in FI attached server (1-4094).", "type": "integer", "format": "int64", "default": 1, "minimum": 1, "maximum": 4094, "x-omitempty": true } } } ] }, "vnic.VxlanSettings": { "title": "Vxlan Settings", "description": "Virtual Extensible LAN Protocol Settings.", "x-allOf-name": "vnic.VxlanSettings", "nullable": true, "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseComplexType" }, { "type": "object", "description": "Definition of the list of properties defined in 'vnic.VxlanSettings', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vnic.VxlanSettings" ], "default": "vnic.VxlanSettings", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vnic.VxlanSettings" ], "default": "vnic.VxlanSettings", "x-enum-as-string": true }, "Enabled": { "description": "Status of the Virtual Extensible LAN Protocol on the virtual ethernet interface.", "type": "boolean", "default": false, "x-omitempty": true } } } ] }, "vrf.Vrf.Response": { "description": "The response body of a HTTP GET request for the 'vrf.Vrf' resource.\nThe value may be one of the following types.\n1. When 'tag' is specified in the URL query, the response schema\n is a summary of the tag usage.\n1. When '$apply' is specified in the URL query, the response schema\n is dynamically-generated schema based on the $apply value.\n1. When '$count' is specified in the URL query, the response is\n a simple object providing the count of the resources.\n1. In all other cases, the response is a list of 'vrf.Vrf' resources.", "x-one-of-name": "vrf.Vrf.Response", "oneOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.DocumentCount" }, { "$ref": "#/components/schemas/vrf.Vrf.List" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.AggregateTransform" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.TagSummary" } ], "discriminator": { "propertyName": "ObjectType" } }, "vrf.Vrf.Relationship": { "description": "A relationship to the 'vrf.Vrf' resource, or the expanded 'vrf.Vrf' resource, or the 'null' value.", "x-one-of-name": "vrf.Vrf.Relationship", "oneOf": [ { "type": "null" }, { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.MoRef" }, { "$ref": "#/components/schemas/vrf.Vrf" } ], "discriminator": { "propertyName": "ClassId" } }, "vrf.Vrf": { "title": "Vrf:Vrf", "description": "The Vrf object implements an isolated Layer 3 domain, enabling advanced networking configurations and routing.\n#### Purpose\nThe Vrf object provides a framework for creating isolated networking domains, facilitating advanced routing and network management within systems.\n#### Key Concepts\n- **Layer 3 Isolation:** Implements isolated Layer 3 domains, supporting advanced network configurations and management.\n- **Network Management:** Facilitates structured management of routing and forwarding, ensuring efficient network operations.\n- **Access Control:** Enables secure configuration and management of VRFs, ensuring authorized access and operations.", "x-allOf-name": "vrf.Vrf", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseMo" }, { "type": "object", "description": "Definition of the list of properties defined in 'vrf.Vrf', excluding properties defined in parent classes.", "required": [ "ClassId", "ObjectType" ], "properties": { "ClassId": { "description": "The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.", "enum": [ "vrf.Vrf" ], "default": "vrf.Vrf", "x-enum-as-string": true }, "ObjectType": { "description": "The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.", "enum": [ "vrf.Vrf" ], "default": "vrf.Vrf", "x-enum-as-string": true }, "Description": { "description": "Description to help identify or describe this VRF.", "type": "string", "x-omitempty": true }, "Name": { "description": "Name of the Virtual Routing and Forwarding Instance.", "type": "string", "x-omitempty": true }, "Account": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/iam.Account.Relationship", "description": "A reference to a iamAccount resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.", "readOnly": true } } } ] }, "vrf.Vrf.List": { "title": "List of 'vrf.Vrf' resources", "description": "This resource list is returned as a response to a HTTP GET request that does not include a specific resource identifier.", "allOf": [ { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/mo.BaseResponse" }, { "type": "object", "properties": { "Count": { "description": "The total number of 'vrf.Vrf' resources matching the request, accross all pages.\nThe 'Count' attribute is included when the HTTP GET request includes the '$inlinecount' parameter.", "type": "integer", "format": "int32" }, "Results": { "description": "The array of 'vrf.Vrf' resources matching the request.", "type": "array", "items": { "$ref": "#/components/schemas/vrf.Vrf" }, "nullable": true } } } ] } }, "parameters": { "moidParam": { "name": "Moid", "in": "path", "required": true, "description": "The unique Moid identifier of a resource instance.", "schema": { "type": "string" } }, "countParam": { "name": "$count", "in": "query", "description": "The $count query specifies the service should return the count of the matching resources, instead of returning the resources.", "required": false, "allowEmptyValue": false, "schema": { "type": "boolean" }, "examples": { "total_count": { "summary": "Return the count of the resources.", "value": "$count=true" }, "count_filtered": { "summary": "Return the count of resources that were created less than two hours ago.", "value": "$count=true&$filter=CreateTime gt now() sub PT2H" } } }, "expandParam": { "name": "$expand", "in": "query", "description": "Specify additional attributes or related resources to return in addition to the primary resources.", "required": false, "schema": { "type": "string" }, "examples": { "expand_displaynames": { "summary": "Return the resources.", "value": "$expand=DisplayNames" } } }, "inlinecountParam": { "name": "$inlinecount", "in": "query", "description": "The $inlinecount query option allows clients to request an inline count of the matching resources included with the resources in the response.", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "enum": [ "allpages", "none" ], "default": "allpages" }, "examples": { "inlinecount_output": { "summary": "Return the count of the resources, and an array containing the resources.", "value": "$inlinecount=true" }, "inlinecount_filtered": { "summary": "Return the count of the resources that were created less than two hours ago, and an array containing the resources.", "value": "$inlinecount=true&$filter=CreateTime gt now() sub PT2H" } } }, "selectParam": { "name": "$select", "in": "query", "description": "Specifies a subset of properties to return.", "required": false, "schema": { "type": "string", "default": "" }, "examples": { "select": { "summary": "Return a summary list of resources. The response will include the Moid, which is always returned, and the 'CreateTime' and 'ModTime' properties.", "value": "$select=CreateTime,ModTime" }, "select_filtered": { "summary": "Return a filtered, summary list of resources.", "value": "$select=CreateTime,ModTime&$filter=CreateTime gt now() sub PT2H", "description": "Return a summary list of resources. The response will include the Moid, which is always returned even if it is not specified in the $select query,\nand the 'CreateTime' and 'ModTime' properties, which are explicitly specified in the $select query.\nThe results are filtered and only include the resources that were created less than two hours ago." } } }, "skipParam": { "name": "$skip", "in": "query", "description": "Specifies the number of resources to skip in the response.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 0 }, "examples": { "skip": { "summary": "Return the resources. Skip the first 100 resources.", "value": "$skip=100" }, "skip_and_top": { "summary": "Return the resources. Skip the first 100 resources and return up to 20 resources.", "value": "$skip=100&$top=20" }, "skip_with_filter": { "summary": "Return the resources that were created less than two hours ago. Skip the first 100 resources and return up to 20 resources.", "value": "$skip=100&$top=20&$filter=CreateTime gt now() sub PT2H" } } }, "topParam": { "name": "$top", "in": "query", "description": "Specifies the maximum number of resources to return in the response.", "required": false, "allowEmptyValue": false, "schema": { "type": "integer", "format": "int32", "default": 100 }, "examples": { "top": { "summary": "Return up to 10 resources.", "value": "$top=10" }, "top_with_filter": { "summary": "Return up to 20 resources that were created less than two hours ago.", "value": "$top=20&$filter=CreateTime gt now() sub PT2H" } } }, "filterParam": { "name": "$filter", "in": "query", "description": "Filter criteria for the resources to return.\nA URI with a $filter query option identifies a subset of the entries from the Collection of Entries. The subset is determined by selecting\nonly the Entries that satisfy the predicate expression specified by the $filter option.\nThe expression language that is used in $filter queries supports references to properties and\nliterals. The literal values can be strings enclosed in single quotes, numbers and boolean values\n(true or false).", "required": false, "schema": { "type": "string", "default": "" }, "examples": { "property_createTime_gt": { "summary": "Return the resources where the 'CreateTime' property is greater than the specified date.", "value": "$filter=CreateTime gt 2012-08-29T21:58:33Z" }, "property_createTime_gt_now": { "summary": "Return the resources that were created less than seventy-two hours ago.", "value": "$filter=CreateTime gt now() sub PT72H", "description": "This example uses a filter expression to compare the 'CreateTime' property of the resource against the current time.\nThe now() function is resolved to the current time in the Intersight service when the query is processed.\n'PT72H' is a string value that represents 72 hours.\nSee https://intersight.com/apidocs for more details about how to construct a duration.\nThe \"sub\" operator is used to substract a duration from the current time." }, "property_createTime_lt_now": { "summary": "Return the resources that were created at least 60 days ago.", "value": "$filter=CreateTime lt now() sub P60D" }, "property_modTime_gt_now1": { "summary": "Return the resources that were modified less than three minutes and 20 seconds ago.", "value": "$filter=ModTime gt now() sub PT3M20S" }, "property_modTime_gt_now2": { "summary": "Return the resources that were modified less than 90 days ago.", "value": "$filter=ModTime gt now() sub P90D" }, "property_modTime_gt_now3": { "summary": "Return the resources that were modified less than 1 day and 12 hours ago.", "value": "$filter=ModTime gt now() sub P1DT12H" } } }, "orderbyParam": { "name": "$orderby", "in": "query", "description": "Determines what properties are used to sort the collection of resources.", "required": false, "schema": { "type": "string" }, "examples": { "date_sort_ascending": { "summary": "Return the resources, sorted by creation time in ascending order, i.e., oldest resources first.", "value": "$orderby=CreationTime" }, "date_sort_descending": { "summary": "Return the resources, sorted by creation time in descending order, i.e., most recently created resources first.", "value": "$orderby=-CreationTime" }, "date_sort_filtered_descending": { "summary": "Return the resources that have been modified less than 80 minutes ago, sorted by modification time, most recently modified resources first.", "value": "$orderby=-ModTime&$filter=ModTime gt now() sub PT80M" }, "sorted_results_with_paging": { "summary": "Return the first 20 resources sorted by modification time.", "value": "$top=20&$orderby=ModTime" } } }, "applyParam": { "name": "$apply", "in": "query", "description": "Specify one or more transformation operations to perform aggregation on the resources. The transformations\nare processed in order with the output from a transformation being used as input for the subsequent transformation.\nThe \"$apply\" query takes a sequence of set transformations, separated by forward slashes to express that they are\nconsecutively applied, i.e., the result of each transformation is the input to the next transformation.\nSupported aggregation methods are \"aggregate\" and \"groupby\".\nThe **aggregate** transformation takes a comma-separated list of one or more aggregate expressions as parameters and returns\na result set with a single instance, representing the aggregated value for all instances in the input set.\nThe **groupby** transformation takes one or two parameters and\n1. Splits the initial set into subsets where all instances in a subset have the same values for the grouping properties specified in the first parameter,\n2. Applies set transformations to each subset according to the second parameter, resulting in a new set of potentially different structure and cardinality,\n3. Ensures that the instances in the result set contain all grouping properties with the correct values for the group,\n4. Concatenates the intermediate result sets into one result set.\nA groupby transformation affects the structure of the result set.", "required": false, "schema": { "type": "string" } }, "atParam": { "name": "at", "in": "query", "description": "Similar to \"$filter\", but \"at\" is specifically used to filter versioning information properties for resources to return.\nA URI with an \"at\" Query Option identifies a subset of the Entries from the Collection of Entries identified by the\nResource Path section of the URI. The subset is determined by selecting only the Entries that satisfy the predicate\nexpression specified by the query option.\nThe expression language that is used in at operators supports references to properties and\nliterals. The literal values can be strings enclosed in single quotes, numbers and boolean values\n(true or false) or any of the additional literal representations shown in the Abstract\nType System section.", "examples": { "versiontype_equality": { "summary": "Return the resources where the 'VersionType' property of the VersionContext is equal to 'Configured'", "value": "at=VersionType eq 'Configured'" }, "interestedmos_query": { "summary": "Return the resources where the 'InterestedMos' property of the VersionContext includes an MoRef with Moid equal to '5b5877e56c6730367acf46cd'", "value": "at=InterestedMos.Moid eq '5b5877e56c6730367acf46cd'" } }, "required": false, "schema": { "type": "string" } }, "tagsParam": { "name": "tags", "in": "query", "description": "The 'tags' parameter is used to request a summary of the Tag utilization for this resource. When the 'tags' parameter is specified, the response provides a list of tag keys, the number of times the key has been used across all documents, and the tag values that have been assigned to the tag key.", "required": false, "schema": { "type": "string" } }, "IfMatch": { "name": "If-Match", "in": "header", "description": "For methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent\nthe lost update problem. It can check if the modification of a resource that the user wants to upload\nwill not override another change that has been done since the original resource was fetched.\nIf the request cannot be fulfilled, the 412 (Precondition Failed) response is returned.\nWhen modifying a resource using POST or PUT, the If-Match header must be set to the value of\nthe resource ModTime property after which no lost update problem should occur.\nFor example, a client send a GET request to obtain a resource, which includes the ModTime property.\nThe ModTime indicates the last time the resource was created or modified. The client then sends\na POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained\nin the GET request.", "required": false, "schema": { "type": "string" } }, "Prefer": { "name": "Prefer", "in": "header", "description": "The Prefer request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request. The \"respond-async\" preference indicates that the client prefers the server to respond asynchronously to a response. The Prefer header is described in RFC 7240.", "required": false, "schema": { "type": "string", "example": "respond-async" } }, "IfNoneMatch": { "name": "If-None-Match", "in": "header", "description": "For methods that apply server-side changes, If-None-Match used with the * value can be used to create\na resource not known to exist, guaranteeing that another resource creation didn't happen before,\nlosing the data of the previous put. The request will be processed only if the eventually existing\nresource's ETag doesn't match any of the values listed. Otherwise, the status code 412\n(Precondition Failed) is used.\nThe asterisk is a special value representing any resource. It is only useful when creating a resource,\nusually with PUT, to check if another resource with the identity has already been created before.\nThe comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are\nconsidered identical if the content is equivalent - they don't have to be identical byte for byte.", "required": false, "schema": { "type": "string" } } }, "links": { "GetIamAccountByMoid": { "operationId": "GetIamAccountByMoid", "parameters": { "Moid": "$response.body#/AccountMoid" }, "description": "The 'AccountMoid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/Accounts/{Moid}'." }, "GetIamDomainGroupByMoid": { "operationId": "GetIamDomainGroupByMoid", "parameters": { "Moid": "$response.body#/DomainGroupMoid" }, "description": "The 'DomainGroupMoid' value returned in the response can be used as the 'Moid' parameter in 'GET /api/v1/iam/DomainGroups/{Moid}'." } }, "responses": { "http_status_400": { "description": "The request could not be understood by the server due to malformed syntax.\nThe client SHOULD NOT repeat the request without modifications.\nFor example, the request may contain an incorrect JSON syntax, or the request fails\nvalidation checks.\nThe HTTP body may contain a document that provides more details about the error.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/Error" } } } }, "http_status_401": { "description": "The request requires user authentication. The client may repeat the request with a suitable Authorization header field.\nIf the request already included Authorization credentials, then the 401 response indicates that authorization has\nbeen refused for those credentials.\nThe HTTP body may contain a document that provides more details about the error.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/Error" } } } }, "http_status_403": { "description": "The request was properly authenticated, but the server is refusing to fulfill it.\nThe HTTP body may contain a document that provides more details about the error.\nFor example, the user may not have sufficient privileges to perform the request.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/Error" } } } }, "http_status_404": { "description": "The specified resource was not found. The HTTP body contains a document that provides more details about the error.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/Error" } } } }, "default": { "description": "An unexpected error occurred.", "headers": { "x-starship-traceid": { "$ref": "#/components/headers/x-starship-traceid" } }, "content": { "application/json": { "schema": { "$ref": "intersight-system-v3-1.0.11-20260807064027971.json#/components/schemas/Error" } } } } }, "headers": { "Set-Cookie": { "description": "Cookie authentication key for use with the `cookieAuth` apiKey authentication.", "schema": { "type": "string", "example": "X-Starship-Token=abcde12345; Path=/" } }, "x-starship-traceid": { "description": "A value that uniquely identifies a HTTP request and its response.", "schema": { "type": "string" } }, "Content-Disposition": { "description": "If not present, indicates the response content is expected to be displayed inline in the browser, that is, as a Web page or as part of a Web page. If present, indicates the response content is expected to be an attachment, that is downloaded and saved locally.", "schema": { "type": "string" } }, "Content-Length": { "description": "Indicates the size of the entity-body, in bytes, sent to the recipient.", "schema": { "type": "integer" } } }, "securitySchemes": { "cookieAuth": { "type": "apiKey", "in": "cookie", "description": "The authentication cookie obtained from a Single-Sign-On SAML assertion.", "name": "X-Starship-Token" }, "http_signature": { "type": "http", "scheme": "signature", "description": "The 'HTTP signature' security scheme. Each HTTP request is cryptographically signed\nas specified in https://datatracker.ietf.org/doc/draft-cavage-http-signatures/.\nSee [Intersight API and SDK documentation](https://intersight.com/apidocs) for details\nabout how to configure the HTTP signature scheme.\nYou must include the following fields in the signed headers.\n 1. '(request-target)'\n 1. '(created)'\n 1. 'Host'\n 1. 'Date'\n 1. 'Digest'\nIn addition, it is recommended that you include at least the following headers.\n 1. '(expires)'\n 1. 'Content-Type'\n* The '(created)' header expresses when the signature was created. The value must be a\n Unix timestamp integer value. Subsecond precision is not supported.\n* The ('expires') header is optional and expresses when the signature ceases to be valid.\n The value must be a Unix timestamp integer value. Subsecond precision is allowed\n using decimal notation.\n It is recommended to set the value of the '(expire)' header to '(created)' plus thirty\n minutes, i.e., the signature is valid for thirty minutes.\n* The 'Digest' header value must be a cryptographic digest of the HTTP request body,\n as specified in RFC 3230.\n* The 'Authorization' header must include the computed signature of the HTTP request.\n The host machine where the API client is running must be synchronized with Internet\n time (i.e., NIST time)." }, "oAuth2": { "type": "oauth2", "description": "The client uses the OAuth2 security scheme. To use OAuth2, a client application\nmust be registered by creating a iam.AppRegistration resource.\nThe user who creates the iam.AppRegistration resource can specify a list of OAuth2\nscopes. These iam.AppRegistration scopes restricts which subset of scopes\na registered client can obtain.\nSupported OAuth2 flows are:\n**Authorization Code**\nIn the authorization code flow, the client sends a list of requested scopes to\nthe authorization URL (/iam/app-authorize). The scope in the authorization request\nmust be one of the scopes that have been configured in the corresponding\niam.AppRegistration resource.\n**Client Credentials**\nIn the client credentials flow, the scope is selected when the AppRegistration\nis created. The client cannot select a specific scope in the token request.", "flows": { "authorizationCode": { "authorizationUrl": "/iam/app-authorize", "tokenUrl": "/iam/token", "refreshUrl": "/iam/token", "scopes": { "ROLE.Account Administrator": "As an Account administrator, you have complete access to all services and resources in Intersight.\nYou can perform all administrative and management tasks, including claim and manage devices, create and deploy Server\nand HyperFlex Cluster profiles, upgrade firmware, perform server actions, cross launch devices, add and manage users and groups,\nconfigure Identity providers and more.\n", "ROLE.Audit Log Viewer": "As an Audit Log Viewer, you can view audit logs.\n", "ROLE.Automation Governance": "As an Automation Governor, you can approve or reject requests to publish generic objects, including Workflows,\nTasks, CDTs, FaaS, and Service Items. Each request is created for a generic asset, enabling automation governance\nto publish these assets.\n", "ROLE.Catalog Administrator": "As a Catalog Administrator, you can create workflows, custom data types, resource selection policies,\nservice items, catalog items, execute catalog item, and view and perform post-deployment operations on the service item\ninstance. Also, you can view and publish the catalog items.\n", "ROLE.Catalog User": "As a Catalog User, you can view the catalog items that are assigned to you. You can deploy the catalog item,\ntrack the catalog item execution, view the service item instance that is created or assigned to you, and\nperform post-deployment operations on the service item instances.\n", "ROLE.Complete Claim": "As a Complete Claim user you can complete the claim of a previously created Target by\nproviding the security token of the device.\nYou do not have access to read the status or details of any devices within the account.\n", "ROLE.Device Administrator": "As a Device Administrator, you can claim and unclaim a device in Intersight, view the device details,\nlicense status, a list of all the claimed devices, and generate API keys.\nYou cannot perform any other management or administrative task in this role.\n", "ROLE.Device Technician": "As a Device Technician you can claim a device, view the device details, license status, a list of\nthe claimed devices, and generate API keys. You cannot perform any other management or\nadministrative task in this role.\n", "ROLE.External Syslog Administrator": "As an External Syslog Administrator, you can configure an external syslog server on an on-prem appliance.\n", "ROLE.HCI Cluster Administrator": "As an HCI Cluster Administrator, you can view and manage HCI Clusters,\nview all the cluster dashboard widgets, view cluster details. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HCI Cluster Operator": "As an HCI Cluster Operator, you can view and manage HCI Clusters,\nview all the cluster dashboard widgets, view cluster details. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HyperFlex Cluster Access Operator": "As a HyperFlex Cluster Access Operator, you can cross launch CLI and HXConnect.\n", "ROLE.HyperFlex Cluster Administrator": "As a HyperFlex Cluster Administrator, you can create, edit, deploy, and manage HyperFlex Clusters,\nview all the cluster dashboard widgets, view cluster details, create HyperFlex policies and profiles, execute\ncapacity planning, and launch HyperFlex Connect. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HyperFlex Cluster Data Protection Administrator": "As a HyperFlex Cluster Data Protection Administrator, you can perform N:1 backups.\n", "ROLE.HyperFlex Cluster Lifecycle Administrator": "As a HyperFlex Cluster Lifecycle Administrator, you can install, expand, upgrade a HX cluster, execute capacity\nplanning, OS installation, VC plugin installation, security hardening, and launch HyperFlex Connect as admin.\n", "ROLE.HyperFlex Cluster Operator": "As a HyperFlex Cluster Operator, you can perform health checks and launch HyperFlex Connect.\nHowever, you cannot change cluster configuration.\n", "ROLE.HyperFlex Cluster Storage Administrator": "As a HyperFlex Cluster Storage Administrator, you can perform datastore, iSCSI, and storage container CRUD operations.\n", "ROLE.HyperFlex Cluster Syslog Administrator": "As a HyperFlex Cluster Syslog Administrator, you can configure the external HX Syslog profile.\n", "ROLE.HyperFlex Cluster System Administrator": "As a HyperFlex Cluster System Administrator, you can perform most system administrator tasks,\ncreate backups, view syslogs, and configure encryption.\n", "ROLE.HyperFlex Cluster System Operator": "As a HyperFlex Cluster System Operator, you can perform encryption, health checks, and post-install tasks.\n", "ROLE.Integrated Systems Administrator": "As an Integrated Systems Administrator, you can perform all actions related to Integrated Systems (e.g., FlexPod) like\ncreate/edit/delete of an Integrated System. In addition you can perform administrative and management tasks related to \ndevices (including claim), servers, server profiles, UCS domain, switch profiles, hypervisors, network/SAN switches, \nstorage devices. Also, you can define workflow and task definitions and can execute them and view workflow executions.\n", "ROLE.Integrated Systems Operator": "As an Integrated Systems Operator, you can view Integrated Systems (e.g., FlexPod) and can run inventory based actions (e.g., Interoperability check) \nIn addition you can view devices, servers, server profiles, UCS domain, switch profiles, hypervisors, network/SAN \nswitches, storage devices and workflows. This role does not include the ability to claim a target. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Kubernetes Administrator": "As a Kubernetes Administrator, you can create, edit, deploy, and manage Kubernetes Clusters. Also, you can\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview and manage storage targets associated with the Kubernetes clusters. The capability to view and execute\nworkflows against the Kubernetes clusters is also granted. It also allows\nthe user to run workflows to manage VMs on hypervisor endpoints, and manage connected storage.\nThe ability to create and view IP pools is also allowed.\nThis role does not include the ability to claim a target.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Kubernetes Operator": "As a Kubernetes Operator, you can view Kubernetes Clusters. Also, you can\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview storage targets associated with the Kubernetes clusters. The capability to view\nworkflows is also granted. It also allows the user to view VMs on hypervisor endpoints.\nThis role also provides the capability to view IP pools.\nThis role does not include the ability to claim a target.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Location Management": "As a user with location management privileges, you can manage location, including creating, updating, and deleting.\n", "ROLE.Network Administrator": "As a Network Administrator, you can create, update, delete and view the Managed network device objects.\nThe capability to view and execute workflows against the network device is also granted.\nThis role does not include the ability to claim a target. You must have a Device Technician, Device Administrator,\nor an Account Administrator role to claim a target.\n", "ROLE.Network Operator": "As a Network Operator, you can view the Managed network device objects. The capability to view workflows against the\nnetwork device is also granted. This role does not include the ability to claim a target. You must have a Device\nTechnician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Nexus Administrator": "As a Nexus Administrator, you have the privileges to perform all Nexus related operations. This includes\nclaiming devices, updating policy configuration, and monitoring the system.\n", "ROLE.Nexus Analyst": "As a Nexus Analyst, you can run and update the available Nexus Cloud analyses such as Sustainability, Conformance, Compliance, and others.\n", "ROLE.Nexus Config Administrator": "As a Nexus Config Administrator, you can create or modify policy configuration and can initiate the\nworkflow that will activate policy changes.\n\nThis role does not allow you to claim or remove devices.\n", "ROLE.Nexus Observer": "As a Nexus Observer, you can generally view the state of all devices. Additional items\ninclude things like viewing configured policies and monitoring active flows. This role does\nnot include any permission which allows the system to be changed.\n", "ROLE.Read-Only": "As a Read-Only user, you can view the dashboard, table views of the managed devices, change your user preferences,\nand generate API keys. You cannot claim a device, add or remove a user, configure Identity providers or\nperform any server actions.\n", "ROLE.SAN Administrator": "As a SAN Administrator, you can create, update, delete and view the Managed SAN switch objects.\nThe capability to view and execute workflows against the SAN switches is also granted.\nThis role does not include the ability to claim a target. You must have a Device Technician, Device Administrator,\nor an Account Administrator role to claim a target.\n", "ROLE.SAN Operator": "As a SAN Operator, you can view the Managed SAN switch objects. The capability to view workflows against the\nSAN switches is also granted. This role does not include the ability to claim a target. You must have a Device\nTechnician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Server Administrator": "As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects,\nview all the server and Fabric Interconnect dashboard widgets, perform server actions,\nview server details, launch management interfaces and the CLI, create and deploy server\npolicies and profiles, and manage API keys. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Service Designer": "As a Service Designer, you can create custom data types, tasks, workflows, resource selection criteria,\nand use these to design the service items. The service designer can validate the service items by using\nthe deployment and post-deployment actions.\n", "ROLE.Service Operator": "As a Service Operator, you can view and update the catalog items, service items, and workflows. Also, you can\nexecute the workflow and validate the catalog or service items.\n", "ROLE.Storage Administrator": "As a Storage Administrator, a user can view and manage Storage devices, view and execute\nworkflows and view all the storage dashboard widgets.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Support Services": "As a Support Services user, you can view the dashboard and table views of managed devices, change your user preferences,\ncollect tech support bundles, and generate API keys. In this role, you cannot claim targets, add or remove users, configure\nIdentity Providers, or perform server actions.\n", "ROLE.Sustainability Metrics Viewer": "As a Sustainability Metrics Viewer user, you have read access to the Energy Management Capability (EMC) features and the ability\nregister an OAuth2 application for programmatic access to the APIs.\n", "ROLE.Tag Management": "As a user with tag management privileges, you can manage tag definitions, including creating, updating, and deleting tags.\n", "ROLE.UCS Domain Administrator": "As a UCS Domain Administrator, you can view and manage Switch Profiles and Network Configuration Policies, view Fabric Interconnect dashboard widgets, perform actions on Switch, launch management interfaces and the CLI, create and deploy switch policies and profiles, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Unified Edge Administrator": "As a Unified Edge Administrator, you can view and manage Switch Profiles, Network and Chassis Configuration Policies, view Unified Edge dashboard widgets, perform actions on Switch and Chassis, launch management interfaces and the CLI, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.User Access Administrator": "As a User Access Administrator, you can add and manage Users and Groups in Intersight, view account details\nand audit logs, manage the IdPs, roles, sessions and API keys for non Account Administrator users.\nHowever, you cannot claim a device or perform any management tasks in Intersight.\nYou cannot add or manage a user with Account Administrator role.\n", "ROLE.Virtualization Administrator": "As a Virtualization Administrator, a user can view and manage hypervisor resources, view\nand execute workflows.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Workflow Designer": "As a Workflow Designer, you can define workflow definitions and custom data types,\nview workflow definitions, task definitions and custom data types, execute workflows and\nview workflow executions.\n", "ROLE.Workload Administrator": "As a Workload Administrator you can view and manage Workload Definitions and Workload Deployments.\n", "ROLE.Workload Operator": "As a Workload Operator you can view and manage Workload Deployments and view Workload Definitions.\n", "ROLE.Workload Optimizer Administrator": "As a Workload Optimizer Administrator, you can access all Workload Optimizer features and perform \nadministrative tasks to configure Workload Optimizer.\n", "ROLE.Workload Optimizer Advisor": "As a Workload Optimizer Advisor, you can view workload optimization state and recommended actions,\nrun plans for workload optimization.\n", "ROLE.Workload Optimizer Automator": "As a Workload Optimizer Automator, you can view workload optimization state, recommended actions,\nrun plans for workload optimization, execute workload optimization actions, and deploy workloads.\n", "ROLE.Workload Optimizer Deployer": "As a Workload Optimizer Deployer, you can view all Workload Optimizer charts and data, deploy \nworkloads, and create policies and templates. You cannot run plans or execute any recommended actions.\n", "ROLE.Workload Optimizer Observer": "As a Workload Optimizer Observer, you can view workload optimization state and recommended actions.\n", "ROLE.vKVM Only": "As a vKVM-only user, you can launch vKVM and tunneled vKVM sessions to a server from Intersight. \nIn addition you can view servers, chassis and the running workflows. \nIn this role, you cannot perform any server actions from Intersight apart from launching vKVM.\n" } }, "clientCredentials": { "tokenUrl": "/iam/token", "scopes": { "ROLE.Account Administrator": "As an Account administrator, you have complete access to all services and resources in Intersight.\nYou can perform all administrative and management tasks, including claim and manage devices, create and deploy Server\nand HyperFlex Cluster profiles, upgrade firmware, perform server actions, cross launch devices, add and manage users and groups,\nconfigure Identity providers and more.\n", "ROLE.Audit Log Viewer": "As an Audit Log Viewer, you can view audit logs.\n", "ROLE.Automation Governance": "As an Automation Governor, you can approve or reject requests to publish generic objects, including Workflows,\nTasks, CDTs, FaaS, and Service Items. Each request is created for a generic asset, enabling automation governance\nto publish these assets.\n", "ROLE.Catalog Administrator": "As a Catalog Administrator, you can create workflows, custom data types, resource selection policies,\nservice items, catalog items, execute catalog item, and view and perform post-deployment operations on the service item\ninstance. Also, you can view and publish the catalog items.\n", "ROLE.Catalog User": "As a Catalog User, you can view the catalog items that are assigned to you. You can deploy the catalog item,\ntrack the catalog item execution, view the service item instance that is created or assigned to you, and\nperform post-deployment operations on the service item instances.\n", "ROLE.Complete Claim": "As a Complete Claim user you can complete the claim of a previously created Target by\nproviding the security token of the device.\nYou do not have access to read the status or details of any devices within the account.\n", "ROLE.Device Administrator": "As a Device Administrator, you can claim and unclaim a device in Intersight, view the device details,\nlicense status, a list of all the claimed devices, and generate API keys.\nYou cannot perform any other management or administrative task in this role.\n", "ROLE.Device Technician": "As a Device Technician you can claim a device, view the device details, license status, a list of\nthe claimed devices, and generate API keys. You cannot perform any other management or\nadministrative task in this role.\n", "ROLE.External Syslog Administrator": "As an External Syslog Administrator, you can configure an external syslog server on an on-prem appliance.\n", "ROLE.HCI Cluster Administrator": "As an HCI Cluster Administrator, you can view and manage HCI Clusters,\nview all the cluster dashboard widgets, view cluster details. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HCI Cluster Operator": "As an HCI Cluster Operator, you can view and manage HCI Clusters,\nview all the cluster dashboard widgets, view cluster details. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HyperFlex Cluster Access Operator": "As a HyperFlex Cluster Access Operator, you can cross launch CLI and HXConnect.\n", "ROLE.HyperFlex Cluster Administrator": "As a HyperFlex Cluster Administrator, you can create, edit, deploy, and manage HyperFlex Clusters,\nview all the cluster dashboard widgets, view cluster details, create HyperFlex policies and profiles, execute\ncapacity planning, and launch HyperFlex Connect. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.HyperFlex Cluster Data Protection Administrator": "As a HyperFlex Cluster Data Protection Administrator, you can perform N:1 backups.\n", "ROLE.HyperFlex Cluster Lifecycle Administrator": "As a HyperFlex Cluster Lifecycle Administrator, you can install, expand, upgrade a HX cluster, execute capacity\nplanning, OS installation, VC plugin installation, security hardening, and launch HyperFlex Connect as admin.\n", "ROLE.HyperFlex Cluster Operator": "As a HyperFlex Cluster Operator, you can perform health checks and launch HyperFlex Connect.\nHowever, you cannot change cluster configuration.\n", "ROLE.HyperFlex Cluster Storage Administrator": "As a HyperFlex Cluster Storage Administrator, you can perform datastore, iSCSI, and storage container CRUD operations.\n", "ROLE.HyperFlex Cluster Syslog Administrator": "As a HyperFlex Cluster Syslog Administrator, you can configure the external HX Syslog profile.\n", "ROLE.HyperFlex Cluster System Administrator": "As a HyperFlex Cluster System Administrator, you can perform most system administrator tasks,\ncreate backups, view syslogs, and configure encryption.\n", "ROLE.HyperFlex Cluster System Operator": "As a HyperFlex Cluster System Operator, you can perform encryption, health checks, and post-install tasks.\n", "ROLE.Integrated Systems Administrator": "As an Integrated Systems Administrator, you can perform all actions related to Integrated Systems (e.g., FlexPod) like\ncreate/edit/delete of an Integrated System. In addition you can perform administrative and management tasks related to \ndevices (including claim), servers, server profiles, UCS domain, switch profiles, hypervisors, network/SAN switches, \nstorage devices. Also, you can define workflow and task definitions and can execute them and view workflow executions.\n", "ROLE.Integrated Systems Operator": "As an Integrated Systems Operator, you can view Integrated Systems (e.g., FlexPod) and can run inventory based actions (e.g., Interoperability check) \nIn addition you can view devices, servers, server profiles, UCS domain, switch profiles, hypervisors, network/SAN \nswitches, storage devices and workflows. This role does not include the ability to claim a target. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Kubernetes Administrator": "As a Kubernetes Administrator, you can create, edit, deploy, and manage Kubernetes Clusters. Also, you can\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview and manage storage targets associated with the Kubernetes clusters. The capability to view and execute\nworkflows against the Kubernetes clusters is also granted. It also allows\nthe user to run workflows to manage VMs on hypervisor endpoints, and manage connected storage.\nThe ability to create and view IP pools is also allowed.\nThis role does not include the ability to claim a target.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Kubernetes Operator": "As a Kubernetes Operator, you can view Kubernetes Clusters. Also, you can\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview storage targets associated with the Kubernetes clusters. The capability to view\nworkflows is also granted. It also allows the user to view VMs on hypervisor endpoints.\nThis role also provides the capability to view IP pools.\nThis role does not include the ability to claim a target.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Location Management": "As a user with location management privileges, you can manage location, including creating, updating, and deleting.\n", "ROLE.Network Administrator": "As a Network Administrator, you can create, update, delete and view the Managed network device objects.\nThe capability to view and execute workflows against the network device is also granted.\nThis role does not include the ability to claim a target. You must have a Device Technician, Device Administrator,\nor an Account Administrator role to claim a target.\n", "ROLE.Network Operator": "As a Network Operator, you can view the Managed network device objects. The capability to view workflows against the\nnetwork device is also granted. This role does not include the ability to claim a target. You must have a Device\nTechnician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Nexus Administrator": "As a Nexus Administrator, you have the privileges to perform all Nexus related operations. This includes\nclaiming devices, updating policy configuration, and monitoring the system.\n", "ROLE.Nexus Analyst": "As a Nexus Analyst, you can run and update the available Nexus Cloud analyses such as Sustainability, Conformance, Compliance, and others.\n", "ROLE.Nexus Config Administrator": "As a Nexus Config Administrator, you can create or modify policy configuration and can initiate the\nworkflow that will activate policy changes.\n\nThis role does not allow you to claim or remove devices.\n", "ROLE.Nexus Observer": "As a Nexus Observer, you can generally view the state of all devices. Additional items\ninclude things like viewing configured policies and monitoring active flows. This role does\nnot include any permission which allows the system to be changed.\n", "ROLE.Read-Only": "As a Read-Only user, you can view the dashboard, table views of the managed devices, change your user preferences,\nand generate API keys. You cannot claim a device, add or remove a user, configure Identity providers or\nperform any server actions.\n", "ROLE.SAN Administrator": "As a SAN Administrator, you can create, update, delete and view the Managed SAN switch objects.\nThe capability to view and execute workflows against the SAN switches is also granted.\nThis role does not include the ability to claim a target. You must have a Device Technician, Device Administrator,\nor an Account Administrator role to claim a target.\n", "ROLE.SAN Operator": "As a SAN Operator, you can view the Managed SAN switch objects. The capability to view workflows against the\nSAN switches is also granted. This role does not include the ability to claim a target. You must have a Device\nTechnician, Device Administrator, or an Account Administrator role to claim a target.\n", "ROLE.Server Administrator": "As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects,\nview all the server and Fabric Interconnect dashboard widgets, perform server actions,\nview server details, launch management interfaces and the CLI, create and deploy server\npolicies and profiles, and manage API keys. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Service Designer": "As a Service Designer, you can create custom data types, tasks, workflows, resource selection criteria,\nand use these to design the service items. The service designer can validate the service items by using\nthe deployment and post-deployment actions.\n", "ROLE.Service Operator": "As a Service Operator, you can view and update the catalog items, service items, and workflows. Also, you can\nexecute the workflow and validate the catalog or service items.\n", "ROLE.Storage Administrator": "As a Storage Administrator, a user can view and manage Storage devices, view and execute\nworkflows and view all the storage dashboard widgets.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Support Services": "As a Support Services user, you can view the dashboard and table views of managed devices, change your user preferences,\ncollect tech support bundles, and generate API keys. In this role, you cannot claim targets, add or remove users, configure\nIdentity Providers, or perform server actions.\n", "ROLE.Sustainability Metrics Viewer": "As a Sustainability Metrics Viewer user, you have read access to the Energy Management Capability (EMC) features and the ability\nregister an OAuth2 application for programmatic access to the APIs.\n", "ROLE.Tag Management": "As a user with tag management privileges, you can manage tag definitions, including creating, updating, and deleting tags.\n", "ROLE.UCS Domain Administrator": "As a UCS Domain Administrator, you can view and manage Switch Profiles and Network Configuration Policies, view Fabric Interconnect dashboard widgets, perform actions on Switch, launch management interfaces and the CLI, create and deploy switch policies and profiles, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Unified Edge Administrator": "As a Unified Edge Administrator, you can view and manage Switch Profiles, Network and Chassis Configuration Policies, view Unified Edge dashboard widgets, perform actions on Switch and Chassis, launch management interfaces and the CLI, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.User Access Administrator": "As a User Access Administrator, you can add and manage Users and Groups in Intersight, view account details\nand audit logs, manage the IdPs, roles, sessions and API keys for non Account Administrator users.\nHowever, you cannot claim a device or perform any management tasks in Intersight.\nYou cannot add or manage a user with Account Administrator role.\n", "ROLE.Virtualization Administrator": "As a Virtualization Administrator, a user can view and manage hypervisor resources, view\nand execute workflows.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "ROLE.Workflow Designer": "As a Workflow Designer, you can define workflow definitions and custom data types,\nview workflow definitions, task definitions and custom data types, execute workflows and\nview workflow executions.\n", "ROLE.Workload Administrator": "As a Workload Administrator you can view and manage Workload Definitions and Workload Deployments.\n", "ROLE.Workload Operator": "As a Workload Operator you can view and manage Workload Deployments and view Workload Definitions.\n", "ROLE.Workload Optimizer Administrator": "As a Workload Optimizer Administrator, you can access all Workload Optimizer features and perform \nadministrative tasks to configure Workload Optimizer.\n", "ROLE.Workload Optimizer Advisor": "As a Workload Optimizer Advisor, you can view workload optimization state and recommended actions,\nrun plans for workload optimization.\n", "ROLE.Workload Optimizer Automator": "As a Workload Optimizer Automator, you can view workload optimization state, recommended actions,\nrun plans for workload optimization, execute workload optimization actions, and deploy workloads.\n", "ROLE.Workload Optimizer Deployer": "As a Workload Optimizer Deployer, you can view all Workload Optimizer charts and data, deploy \nworkloads, and create policies and templates. You cannot run plans or execute any recommended actions.\n", "ROLE.Workload Optimizer Observer": "As a Workload Optimizer Observer, you can view workload optimization state and recommended actions.\n", "ROLE.vKVM Only": "As a vKVM-only user, you can launch vKVM and tunneled vKVM sessions to a server from Intersight. \nIn addition you can view servers, chassis and the running workflows. \nIn this role, you cannot perform any server actions from Intersight apart from launching vKVM.\n", "PRIVSET.API keys": "Manage API keys used for secure access to system resources and services.\n", "PRIVSET.API keys and OAuth tokens": "Manage API keys and OAuth tokens used for secure access to system resources and services.\n", "PRIVSET.Access and permissions": "Manage access of users, user groups; and organizations, resource groups, and roles; and IP access management.\n", "PRIVSET.Access domains": "Log in and interact with domain settings.\n", "PRIVSET.Access servers": "Log in and interact with servers to perform operations based on privileges.\n", "PRIVSET.Account": "Manage Intersight account settings.\n", "PRIVSET.Account Administrator": "A set of privileges that provides complete access to all services and resources in Intersight.\n", "PRIVSET.Acknowledge advisories": "Acknowledge the filed notices, end-of-life and security advisories.\n", "PRIVSET.Acknowledge alarms": "Acknowledge the alarms.\n", "PRIVSET.Activate server profiles": "Activate the profile on the attached server.\n", "PRIVSET.Activate webhook": "As an Activate Webhooks user, you can enable webhooks, allowing them to start receiving and processing notifications and data from the system.\n", "PRIVSET.Adapter Configuration policies": "Configure Ethernet and Fibre Channel settings for the Virtual Interface Card (VIC), including features like VXLAN, NVGRE, and TCP Offload settings.\n", "PRIVSET.Add OS configuration links": "Upload an OS configuration file for automated and unattended OS installation on servers to improve deployment efficiency.\n", "PRIVSET.Add OS image links": "Add the image source of the operating system, specifying the file share location and protocol (CIFS/NFS/HTTPS) to the software repository.\n", "PRIVSET.Add SCU links": "Add the Server Configuration Utility (SCU) for automated OS installation, specifying file share locations using NFS, CIFS, or HTTP protocols.\n", "PRIVSET.Add and remove server profile template tags": "Assign and manage tags for server profiles.\n", "PRIVSET.Add domain names": "Configure and add a domain name to the system for proper network addressing and identification of resources.\n", "PRIVSET.Add explorations to dashboard": "Add an exploration to the Intersight dashboard.\n", "PRIVSET.Add external syslog servers": "Configure and add external Syslog servers to the system for centralized collection and management of log data from various sources.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Add firmware links": "Add a firmware source to the software repository by specifying the file share location and protocol (NFS/CIFS/HTTP[S]) for firmware upgrades.\n", "PRIVSET.Add identity providers": "Configure and add a new identity provider (IdP) to the system, enabling authentication and access management through external or federated identity services.\n", "PRIVSET.Add notification rule or webhook": "Create and configure new notification rules, defining criteria and actions for alerting users based on specific events or conditions.\n", "PRIVSET.Add trusted IP ranges": "Add trusted IP ranges.\n", "PRIVSET.Add trusted certificates": "Upload and install certificates that are trusted by the system, enabling secure communications and verifying connection authenticity.\n", "PRIVSET.Alerts": "Manage the alerts from advisories, and alarms.\n", "PRIVSET.Allow or Disallow Data Collection": "Enable and disable proactive RMA, tech support bundle collection, sending additional system information to Cisco.\n", "PRIVSET.Allow/disallow FI and Unified Edge eCMC CLI launches": "Enable or disable launch of FI and Unified Edge eCMC CLI.\n", "PRIVSET.Allow/disallow tech support bundles": "Enable or disable tech support incident bundle collection.\n", "PRIVSET.Allow/disallow tunneled vKVM configurations": "Enable or disable configuration of tunneled vKVM access.\n", "PRIVSET.Allow/disallow tunneled vKVM launches": "Enable or disable launch of tunneled vKVM access.\n", "PRIVSET.Appliance authentication": "Manage authentication in Intersight appliance using Single sign-on (SSO), Cisco ID, SSL/TLS Certificate and LDAP.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Appliance configuration": "Manage the configuration settings of the Intersight appliance.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Appliance networking": "Manage networking settings related to the appliance.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Appliance security & privacy": "Managing system maintenance and data sharing features related to Proactive RMA feature and option to send supplementary diagnostic and operational data to Cisco.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Apply SSL Certificate": "As a user with the ability to apply SSL certificates, you can install and configure SSL certificates for secure communications.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Approve Publish Requests": "Approve Publish Requests\n", "PRIVSET.Assign chassis profiles": "Link domain profiles to servers for management.\n", "PRIVSET.Assign domain profiles": "Link domain profiles for server management.\n", "PRIVSET.Assign server profiles": "Assign a server to the server profile.\n", "PRIVSET.Attach to and detach from chassis profile templates": "It allows to attach any policies to server profile and removal of policies from chassis profile.\n", "PRIVSET.Attach to and detach from domain profile templates": "It allows to attach any policies to domain profile template and removal of policies from domain profile template.\n", "PRIVSET.Attach to and detach from server profile templates": "It allows to attach any policies to server profile and removal of policies from server profile.\n", "PRIVSET.Audit Log Viewer": "As an Audit Log Viewer, you can view audit logs.\n", "PRIVSET.Audit logs": "Manage and view audit logs.\n", "PRIVSET.AuditD policies": "Manage logging of user activities, configuration changes, and operational commands for FIs, leveraging the Linux audit daemon framework (auditd).\n", "PRIVSET.Authentication": "Manage authentication methods and policies for securing system access.\n", "PRIVSET.Authentication settings": "As a user with access to Authentication settings, you can manage and configure the authentication methods and policies for securing access to the system.\n", "PRIVSET.Automation Governance": "As Automation Governor, you can approve or reject approval requests.\n", "PRIVSET.BIOS policies": "Set the BIOS policies.\n", "PRIVSET.Boot Order policies": "Set the BIOS boot mode, and enable secure boot.\n", "PRIVSET.Catalog Administrator": "As a Catalog Administrator, you can create tasks, workflows, custom datatypes, resource selection criteria,\nservice items and use these building blocks to create catalog items. You can validate these catalog items\nby deploying them and performing post-deployment operations on the deployed resources. The catalog administrator\ncan publish the catalog items to an organization so that these can be consumed by the catalog users in\nthat organization.\n", "PRIVSET.Catalog User": "As a Catalog User, you can view the catalog items assigned to you, deploy the catalog item, track the\nservice requests, view the service item instance that you have created or are assigned to you, and\nperform post-deployment operations on the resource.\n", "PRIVSET.Certificate Management policies": "Specify and attach external certificate details to servers, supporting Root CA and IMC certificates.\n", "PRIVSET.Cisco ID": "Manage Cisco identification credentials and settings used for accessing Cisco services.\n", "PRIVSET.Claim Devices": "Claim devices.\n", "PRIVSET.Claim targets": "Assign or register a target to the system for management or monitoring purposes.\n", "PRIVSET.Clear TPMs": "Clear the Trusted Platform Module (TPM) on servers.\n", "PRIVSET.Clear configurations": "Remove foreign configurations not integrated with current setups.\n", "PRIVSET.Clear foreign configurations": "Remove foreign configurations from a server's storage system to clear external storage setups that are not integrated with the server's current configuration.\n", "PRIVSET.Clear system event logs (SEL)": "Erase the system event log (SEL), clearing recorded events.\n", "PRIVSET.Clusters": "Manage and configure clusters.\n", "PRIVSET.Complete Claim": "As a Complete Claim user you can complete the claim of a previously created Target by\nproviding the security token of the device.\nYou do not have access to read the status or details of any devices within the account.\n", "PRIVSET.Configure": "Configure physical servers, chassis, and domains along with their respective profiles and templates, \nwhile managing compute, management, network, and storage policies, and configuring pools of Intersight Infrastructure Services.\n", "PRIVSET.Configure Cisco software download credentials": "Set up and manage credentials required for accessing and downloading Cisco software to ensure secure and authorized access to updates and resources.Set up and manage credentials required for accessing and downloading Cisco software to ensure secure and authorized access to updates and resources.\n", "PRIVSET.Configure DNS settings": "Set up and manage Domain Name System (DNS) configurations, including DNS servers, domain names, and search domains to ensure proper name resolution and network connectivity.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure IP pools": "Manages the collection of IP addresses that can be dynamically assigned to services running on network elements. It supports both IPv4 and IPv6 addresses and can be configured at either the pool level or block level.\n", "PRIVSET.Configure IQN pools": "Define and manage iSCSI Qualified Names (IQNs) pools for organized iSCSI identifier assignment.\n", "PRIVSET.Configure LDAP servers": "Set up and manage LDAP server settings, including server address, port, authentication methods, and directory structures to enable directory services and authentication.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure Local Users Password Policy": "Set up and manage the password policy for local users, including requirements for password complexity, expiration, and reset procedures to ensure secure access control.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure MAC pools": "Manage the collection of MAC addresses that are unique in their Layer 2 environment, used to assign to vNICs on a server. This helps in automating the assignment of MAC addresses in server profiles.\n", "PRIVSET.Configure MFA": "Set up and manage Multi-Factor Authentication (MFA) settings, including configuring authentication methods, policies, and user access requirements to enhance security.\n", "PRIVSET.Configure NTP settings": "Set up and manage Network Time Protocol (NTP) configurations, including NTP servers and time synchronization settings to ensure accurate and consistent time across the network.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure Resource Pool": "Manage pool aggregation of homogeneous resources, such as servers, to manage their utilization efficiently. It allows for logical grouping and management of resources for server profiles\n", "PRIVSET.Configure SMTP servers": "Set up and manage Simple Mail Transfer Protocol (SMTP) server settings, including server address, port, authentication, and security settings to enable and configure email functionality.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure UUID pools": "Manage universally unique identifier (UUID) for each server associated with a server profile, ensuring that each server has a unique identifier.\n", "PRIVSET.Configure WWNN or WWPN pools": "Manage world wide node name (WWNN) or world wide port name (WWPN) pools to provide unique IDs for Fibre Channel nodes and ports on a server.\n", "PRIVSET.Configure account details": "Set up and modify account information, including user credentials, contact details, and other account-specific settings.\n", "PRIVSET.Configure backup schedule": "Set up and modify schedules for automated backups, defining timing, frequency, and scope to ensure regular and reliable data protection.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure banner message": "Set up and modify banner messages displayed to users, providing important information, warnings, or notifications within the system interface.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure chassis profile templates": "Manage chassis profile template settings.\n", "PRIVSET.Configure chassis profiles": "Manage chassis profile settings to ensure configurations align with operational requirements and organizational standards.\n", "PRIVSET.Configure compute policies": "Create, Clone, Edit or Delete the compute policies of Cisco UCS which define the configuration parameters for server resources.\n", "PRIVSET.Configure data collection settings": "As a user with the ability to Configure Data Collection Settings, you can manage the proactive return merchandise authorization settings for the system.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure device connector settings": "Set up and manage the configuration for device connectors, including network settings and parameters needed for device communication and integration within the appliance networking environment.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure domain profile templates": "Manage domain profile template.\n", "PRIVSET.Configure domain profiles": "Manage domain profiles to define and apply network, storage, and compute configurations across systems.\n", "PRIVSET.Configure management policies": "Create, Clone, Edit or Delete the policies that manage different aspects of network management, such as adapter and ethernet policies, fibre channel and iSCSI policies, traffic and flow control, connectivity and control, virtualization and group management. It includes certificate management, device connector, IPMI over LAN, LDAP, local user, network connectivity, NTP, serial over LAN, SMTP, SNMP, SSH, Syslog, and virtual KVM policies.\n", "PRIVSET.Configure metrics settings": "Set up and manage the configuration of metrics collection and reporting, defining which metrics are tracked, how they are recorded, and how they are displayed for analysis.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure network policies": "It allows setting up various policies to manage Ethernet and Fibre Channel settings, as well as network communication resources between servers and the LAN or SAN. It includes adapter configuration, iSCSI boot, LAN connectivity, and SAN connectivity policies.\n", "PRIVSET.Configure physical chassis": "Manage settings of a physical chassis to ensure optimal configuration and operation of chassis components within your infrastructure.\n", "PRIVSET.Configure physical domains": "Manage settings of physical domains.\n", "PRIVSET.Configure physical servers": "Configure settings and perform actions on physical servers to ensure they meet operational requirements.\n", "PRIVSET.Configure pools": "Manage resource pools like IP, MAC, WWPN, and storage pools for efficient resource allocation.\n", "PRIVSET.Configure server profile templates": "Create or modify server profiles templates by setting up specific configurations, assigning resources, and updating settings to ensure the server operates according to required specifications.\n", "PRIVSET.Configure server profiles": "Create or modify server profiles by setting up specific configurations, assigning resources, \nand updating settings to ensure the server operates according to required specifications.\n", "PRIVSET.Configure software update settings": "Set up and manage settings related to software updates, including scheduling, sources, and policies to ensure that software remains current and secure.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Configure storage policies": "It allows setting up various policies to manage storage resources effectively. It includes Drive Security, SD Card, and Storage policies.\n", "PRIVSET.Configure vHBA templates": "Manage vHBA Templates.\n", "PRIVSET.Configure vNIC templates": "Manage vNIC Templates.\n", "PRIVSET.Create Approval Request": "Create Approval Request\n", "PRIVSET.Create CSR": "As a user with the ability to create Certificate Signing Requests (CSR), you can generate requests for digital certificates to establish secure communications.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Create IP pool address reservations": "Reserve specific IP addresses within pools.\n", "PRIVSET.Create IP pools": "", "PRIVSET.Create IQN pool address reservations": "Reserve specific iSCSI Qualified Names (IQNs) within an IQN pool to ensure allocation for particular devices and restrict general assignment.\n", "PRIVSET.Create IQN pools": "Create new iSCSI Qualified Name (IQN) pools, configuring settings for iSCSI targets.\n", "PRIVSET.Create MAC pool address reservations": "Reserve specific MAC addresses within pools.\n", "PRIVSET.Create MAC pools": "Create new MAC address pools, configuring settings for network devices.\n", "PRIVSET.Create Nexus Reports": "A set of privileges that allow the users to create nexus reports.\n", "PRIVSET.Create OAuth 2.0 grant type applications": "Register new applications with OAuth 2.0 grant types, defining their authentication and authorization settings for secure access.\n", "PRIVSET.Create Resource pool address reservations": "Reserve specific resources within a resource pool to ensure allocation for particular uses and restrict general assignment.\n", "PRIVSET.Create Resource pools": "Create new resource pools, configuring settings for system resource allocation.\n", "PRIVSET.Create UUID pool address reservations": "Reserve specific UUIDs within a UUID pool to ensure allocation for particular devices and restrict general assignment.\n", "PRIVSET.Create UUID pools": "Create new universally unique identifier (UUID) pools, configuring settings for devices or services.\n", "PRIVSET.Create WWNN and WWPN pool address reservations": "Reserve specific World Wide Node Names (WWNNs) or World Wide Port Names (WWPNs) within their respective pools to ensure allocation for particular devices and restrict general assignment.\n", "PRIVSET.Create WWNN or WWPN pools": "Create new WWNN or WWPN pools, managing identifiers for devices.\n", "PRIVSET.Create backups": "Initiate the creation of backup copies of data to ensure important information is saved and can be restored in case of data loss or corruption.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Create chassis profile templates from chassis profile": "Create chassis profile templates to serve as the foundation for multiple derived chassis profiles.\n", "PRIVSET.Create domain profile templates from domain profile": "Create domain profile templates from domain profiles.\n", "PRIVSET.Create integrated systems": "Create new integrated systems.\n", "PRIVSET.Create server profile template from server profile": "Generate new server profile templates from an existing server profiles.\n", "PRIVSET.Create, clone and edit Adapter Configuration policies": "", "PRIVSET.Create, clone and edit AuditD policies": "", "PRIVSET.Create, clone and edit BIOS policies": "", "PRIVSET.Create, clone and edit Boot Order policies": "", "PRIVSET.Create, clone and edit Certificate Management policies": "", "PRIVSET.Create, clone and edit Device Connector policies": "", "PRIVSET.Create, clone and edit Drive Security policies": "", "PRIVSET.Create, clone and edit Ethernet Adapter policies": "", "PRIVSET.Create, clone and edit Ethernet Network Control policies": "", "PRIVSET.Create, clone and edit Ethernet Network Group policies": "", "PRIVSET.Create, clone and edit Ethernet Network policies": "", "PRIVSET.Create, clone and edit Ethernet QoS policies": "", "PRIVSET.Create, clone and edit FC Zone policies": "", "PRIVSET.Create, clone and edit Fibre Channel Adapter policies": "", "PRIVSET.Create, clone and edit Fibre Channel Network policies": "", "PRIVSET.Create, clone and edit Fibre Channel QoS policies": "", "PRIVSET.Create, clone and edit Firmware policies": "", "PRIVSET.Create, clone and edit Flow Control policies": "", "PRIVSET.Create, clone and edit IMC Access policies": "", "PRIVSET.Create, clone and edit IPMI over LAN policies": "", "PRIVSET.Create, clone and edit LAN Connectivity policies": "", "PRIVSET.Create, clone and edit LDAP policies": "", "PRIVSET.Create, clone and edit Link Aggregation policies": "As a Create or Clone Link Aggregation Policy user, you can define and establish new policies for link aggregation, \nconfiguring settings to combine multiple network connections into a single logical link for improved performance and redundancy.\n", "PRIVSET.Create, clone and edit Link Control policies": "As a Create or Clone Link Control Policy user, you can define and establish new policies for link control, \nconfiguring settings to manage and optimize network link behavior and performance.\n", "PRIVSET.Create, clone and edit Local User policies": "", "PRIVSET.Create, clone and edit Memory policies": "As a Create or Clone Memory Policy user, you can define and establish new memory policies.\n", "PRIVSET.Create, clone and edit Multicast policies": "", "PRIVSET.Create, clone and edit NTP policies": "", "PRIVSET.Create, clone and edit Network Connectivity policies": "", "PRIVSET.Create, clone and edit Persistent Memory policies": "", "PRIVSET.Create, clone and edit Port policies": "", "PRIVSET.Create, clone and edit Power policies": "", "PRIVSET.Create, clone and edit SAN Connectivity policies": "", "PRIVSET.Create, clone and edit SD Card policies": "", "PRIVSET.Create, clone and edit SMTP policies": "", "PRIVSET.Create, clone and edit SNMP policies": "", "PRIVSET.Create, clone and edit SSH policies": "", "PRIVSET.Create, clone and edit Scrub policies": "As a Create or Clone Scrub Policy user, you can define and establish new Scrub policies within the system, \nconfiguring virtual media access and management settings for devices.\n", "PRIVSET.Create, clone and edit Serial Over LAN policies": "", "PRIVSET.Create, clone and edit Storage policies": "", "PRIVSET.Create, clone and edit Switch Control policies": "", "PRIVSET.Create, clone and edit Syslog policies": "", "PRIVSET.Create, clone and edit System QoS policies": "", "PRIVSET.Create, clone and edit Thermal policies": "", "PRIVSET.Create, clone and edit VLAN policies": "", "PRIVSET.Create, clone and edit VSAN policies": "", "PRIVSET.Create, clone and edit Virtual KVM policies": "", "PRIVSET.Create, clone and edit Virtual Media policies": "", "PRIVSET.Create, clone and edit iSCSI Adapter policies": "", "PRIVSET.Create, clone and edit iSCSI Boot policies": "", "PRIVSET.Create, clone and edit iSCSI Static Target policies": "As a Create or Clone iSCSI Static Target Policy user, you can define and establish new policies for iSCSI static targets, \nconfiguring settings to manage and optimize the connections to specific iSCSI targets within the storage network.\n", "PRIVSET.Create, clone, and edit chassis profile templates": "Create, clone and edit chassis profile templates to define and manage configuration settings for physical chassis.\n", "PRIVSET.Create, clone, and edit chassis profiles": "Create and manage chassis profiles.\n", "PRIVSET.Create, clone, and edit domain profile templates": "Create, clone and edit domain profile templates.\n", "PRIVSET.Create, clone, and edit domain profiles": "Create, clone and edit domain profiles by configuring settings and policies to standardize domain operations.\n", "PRIVSET.Create, clone, and edit server profile templates": "Create and manage server profiles templates.\n", "PRIVSET.Create, clone, and edit server profiles": "Create and manage server profiles, attach/detach policies.\n", "PRIVSET.Create, clone, and edit vHBA templates": "Create, clone and edit vHBA Templates.\n", "PRIVSET.Create, clone, and edit vNIC templates": "Create, clone and edit vNIC Templates.\n", "PRIVSET.Datacenters": "Manage and configure datacenters.\n", "PRIVSET.Datastore clusters": "Manage and configure datastore clusters.\n", "PRIVSET.Datastores": "Manage and configure datastores.\n", "PRIVSET.Decommission Fabric Extender (FEX)": "Safely retire and remove Fabric Extenders (FEX), deactivating related connections and updating the system status. \n", "PRIVSET.Decommission chassis": "Safely retire and remove chassis.\n", "PRIVSET.Decommission servers": "Safely shut down servers, disconnect from the network, and ensure data is erased and backed up in alignment with policies.\n", "PRIVSET.Define and edit chassis profile general properties": "Set or edit name, description, organization and tag of chassis profiles.\n", "PRIVSET.Define and edit chassis profile template general properties": "Set or edit name, description, organization and tag of chassis profile templates.\n", "PRIVSET.Define and edit domain profile general properties": "Add or edit name, description, organization and tag for UCS domain profiles.\n", "PRIVSET.Define and edit domain profile template general properties": "Set or edit name, description, organization and tag of domain profile templates.\n", "PRIVSET.Define and edit server profile general properties": "Set or edit the Organization, name, description, tag of Server Profile.\n", "PRIVSET.Define and edit server profile template general properties": "Set or edit name, description, organization and tag of server profile templates.\n", "PRIVSET.Define and edit vHBA template general properties": "Set or edit name, description, organization and tag of vHBA templates.\n", "PRIVSET.Define and edit vNIC template general properties": "Add or edit the name, description and tag for the vNIC templates.\n", "PRIVSET.Delete API keys": "Remove API keys from the system, terminating their access to system APIs and ensuring they are no longer valid for integration or automation purposes.\n", "PRIVSET.Delete Adapter Configuration policies": "", "PRIVSET.Delete Approval Request": "Delete Approval Request\n", "PRIVSET.Delete AuditD policies": "", "PRIVSET.Delete BIOS policies": "", "PRIVSET.Delete Boot Order policies": "", "PRIVSET.Delete CSR": "As a user with the ability to delete Certificate Signing Requests (CSR), you can remove existing requests for digital certificates from the system.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Delete Certificate Management policies": "", "PRIVSET.Delete Device Connector policies": "", "PRIVSET.Delete Devices": "Delete Devices.\n", "PRIVSET.Delete Drive Security policies": "", "PRIVSET.Delete Ethernet Adapter policies": "", "PRIVSET.Delete Ethernet Network Control policies": "", "PRIVSET.Delete Ethernet Network Group policies": "", "PRIVSET.Delete Ethernet Network policies": "", "PRIVSET.Delete Ethernet QoS policies": "", "PRIVSET.Delete FC Zone policies": "", "PRIVSET.Delete Fibre Channel Adapter policies": "", "PRIVSET.Delete Fibre Channel Network policies": "", "PRIVSET.Delete Fibre Channel QoS policies": "", "PRIVSET.Delete Firmware policies": "", "PRIVSET.Delete Flow Control policies": "", "PRIVSET.Delete IMC Access policies": "", "PRIVSET.Delete IP pool address reservations": "Remove IP address reservations, freeing them for use.\n", "PRIVSET.Delete IP pools": "", "PRIVSET.Delete IPMI over LAN policies": "", "PRIVSET.Delete IQN pool address reservations": "Remove specific IQN reservations from an IQN pool to make them available for general assignment.\n", "PRIVSET.Delete IQN pools": "Remove existing iSCSI Qualified Name (IQN) pools, managing outdated IQN allocations.\n", "PRIVSET.Delete LAN Connectivity policies": "", "PRIVSET.Delete LDAP policies": "", "PRIVSET.Delete LDAP servers": "Remove the configuration of LDAP servers, ceasing the directory services and authentication provided by those servers.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Delete Link Aggregation policies": "As a Delete Link Aggregation Policy user, you can remove existing link aggregation policies, \nmanaging outdated or unnecessary settings related to network connection combinations.\n", "PRIVSET.Delete Link Control policies": "As a Delete Link Control Policy user, you can remove existing link control policies, \nmanaging outdated or unnecessary settings related to network link management.\n", "PRIVSET.Delete Local User policies": "", "PRIVSET.Delete MAC pool address reservations": "Remove MAC address reservations, freeing them for use.\n", "PRIVSET.Delete MAC pools": "Remove existing MAC pools, managing outdated MAC address allocations.\n", "PRIVSET.Delete Memory policies": "As a Delete Memory Policy user, you can remove existing Memory policies,\nmanaging outdated or unnecessary permissions and access settings.\n", "PRIVSET.Delete Multicast policies": "", "PRIVSET.Delete NTP policies": "", "PRIVSET.Delete Network Connectivity policies": "", "PRIVSET.Delete OAuth 2.0 grant type applications": "Remove OAuth 2.0 grant type applications from the system, revoking their access and associated permissions.\n", "PRIVSET.Delete OAuth 2.0 tokens": "Remove OAuth 2.0 tokens from the system, revoking their access and preventing their use for authentication and authorization.\n", "PRIVSET.Delete OS configuration links": "Remove the OS configuration file for automated and unattended OS installation on servers.\n", "PRIVSET.Delete OS image links": "Remove the image source of the operating system from the software repository, deleting file share location and protocol (CIFS/NFS/HTTPS).\n", "PRIVSET.Delete Persistent Memory policies": "", "PRIVSET.Delete Port policies": "", "PRIVSET.Delete Power policies": "", "PRIVSET.Delete Resource pool address reservations": "Remove specific resource reservations from a resource pool to make them available for general assignment.\n", "PRIVSET.Delete Resource pools": "Remove existing resource pools, managing outdated allocations.\n", "PRIVSET.Delete SAN Connectivity policies": "", "PRIVSET.Delete SCU links": "Remove the Server Configuration Utility (SCU) for automated OS installation, deleting file share locations using NFS, CIFS, or HTTP protocols.\n", "PRIVSET.Delete SD Card policies": "", "PRIVSET.Delete SMTP policies": "", "PRIVSET.Delete SNMP policies": "", "PRIVSET.Delete SSH policies": "", "PRIVSET.Delete Scrub policies": "As a Delete Scrub Policy user, you can remove existing Scrub policies from the system, \nmanaging outdated or unnecessary virtual media configurations.\n", "PRIVSET.Delete Serial Over LAN policies": "", "PRIVSET.Delete Storage policies": "", "PRIVSET.Delete Switch Control policies": "", "PRIVSET.Delete Syslog policies": "", "PRIVSET.Delete System QoS policies": "", "PRIVSET.Delete Thermal policies": "", "PRIVSET.Delete UUID pool address reservations": "Remove specific UUID reservations from a UUID pool to make them available for general assignment.\n", "PRIVSET.Delete UUID pools": "Remove existing universally unique identifier (UUID) pools, managing outdated UUID allocations.\n", "PRIVSET.Delete VLAN policies": "", "PRIVSET.Delete VSAN policies": "", "PRIVSET.Delete Virtual KVM policies": "", "PRIVSET.Delete Virtual Media policies": "", "PRIVSET.Delete WWNN and WWPN pool address reservations": "Remove specific WWNN or WWPN reservations from pools to make them available for general assignment.\n", "PRIVSET.Delete WWNN or WWPN pools": "Remove existing WWNN or WWPN pools, managing outdated allocations.\n", "PRIVSET.Delete chassis profile templates": "Remove existing chassis profile templates.\n", "PRIVSET.Delete chassis profiles": "Remove existing chassis profiles from your infrastructure, ensuring outdated or unnecessary configurations are managed.\n", "PRIVSET.Delete domain names": "Remove existing domain names from the system, ceasing their use for network addressing and identification of resources.\n", "PRIVSET.Delete domain profile templates": "Delete domain profile templates.\n", "PRIVSET.Delete domain profiles": "Delete domain profiles from the system, ensuring associated configurations are managed.\n", "PRIVSET.Delete explorations": "Delete an existing exploration.\n", "PRIVSET.Delete external syslog servers": "Remove the configuration of external Syslog servers from the system, ceasing the collection and management of log data from those servers.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Delete firmware links": "Remove the firmware source from the software repository by deleting the file share location and protocol (NFS/CIFS/HTTP[S]).\n", "PRIVSET.Delete iSCSI Adapter policies": "", "PRIVSET.Delete iSCSI Boot policies": "", "PRIVSET.Delete iSCSI Static Target policies": "As a Delete iSCSI Static Target Policy user, you can remove existing iSCSI static target policies, \nmanaging outdated or unnecessary settings related to specific iSCSI target connections.\n", "PRIVSET.Delete identity providers": "Remove existing IdPs from the system, discontinuing associated authentication and access management services.\n", "PRIVSET.Delete integrated systems": "Delete an existing integrated system.\n", "PRIVSET.Delete notification rule or webhook": "Remove existing notification rules, stopping the triggering and management of alerts and notifications based on those rules.\n", "PRIVSET.Delete server profile templates": "Remove server profile templates.\n", "PRIVSET.Delete server profiles": "Remove server profiles.\n", "PRIVSET.Delete trusted IP ranges": "Delete the trusted IP range.\n", "PRIVSET.Delete trusted certificates": "Remove certificates from the system's list of trusted certificates, ceasing their use for secure communications.\n", "PRIVSET.Delete vHBA templates": "Delete vHBA Templates.\n", "PRIVSET.Delete vNIC templates": "Delete vNIC Templates.\n", "PRIVSET.Deploy chassis profiles": "Apply domain profiles to servers, implementing settings.\n", "PRIVSET.Deploy domain profiles": "Apply domain profiles, implementing server settings.\n", "PRIVSET.Deploy server profiles": "Deploy the profile to the attached server.\n", "PRIVSET.Deregister Smart Licenses": "Cancel the registration of your device.\n", "PRIVSET.Derive profiles from chassis profile templates": "Create profiles derived from chassis profile templates.\n", "PRIVSET.Derive profiles from domain profile templates": "Create profiles derived from domain profile templates.\n", "PRIVSET.Derive server profiles": "Create new server profiles using existing profiles or templates.\n", "PRIVSET.Device Administrator": "As a Device Administrator, you can claim and unclaim a device in Intersight, view the device details,\nlicense status, a list of all the claimed devices, and generate API keys.\nYou cannot perform any other management or administrative task in this role.\n", "PRIVSET.Device Connector policies": "Control configuration changes allowed from Cisco IMC, ensuring that changes are managed through Intersight.\n", "PRIVSET.Device Technician": "As a Device Technician you can claim a device, view the device details, license status, a list of\nthe claimed devices, and generate API keys. You cannot perform any other management or\nadministrative task in this role.\n", "PRIVSET.Devices": "A set of privileges that allows the access to manage devices e.g. view device details, claim and delete devices.\n", "PRIVSET.Disable security": "Deactivate security features on storage systems.\n", "PRIVSET.Disable subscriptions": "Disable visibility of subscription details in the Intersight appliance.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Domain names": "Manage the configurations and settings related to domain names within the system.\n", "PRIVSET.Download server event logs": "Download the server's event log (SEL) to review and analyse recorded events and errors for diagnostics.\n", "PRIVSET.Drive Security policies": "Define self-encrypting drives (SEDs) management to ensure data security using a Key-Encryption Key (KEK) and a Key Management Interoperability Protocol (KMIP) for remote key management.\n", "PRIVSET.Edit API keys": "Modify settings and permissions associated with existing API keys, managing their scope and access to ensure proper integration and security.\n", "PRIVSET.Edit Adapter Configuration policies": "", "PRIVSET.Edit Adapter Configuration policies for server profile": "Attach/detach Adapter Configuration policies.\n", "PRIVSET.Edit Adapter Configuration policies for server profile template": "Attach/detach Adapter Configuration policies.\n", "PRIVSET.Edit AuditD policies": "", "PRIVSET.Edit AuditD policies for domain profile": "Attach/detach AuditD policies.\n", "PRIVSET.Edit AuditD policies for domain profile template": "Attach/detach AuditD policies.\n", "PRIVSET.Edit BIOS policies": "", "PRIVSET.Edit BIOS policies for server profile": "Attach/detach BIOS policies.\n", "PRIVSET.Edit BIOS policies for server profile template": "Attach/detach BIOS policies.\n", "PRIVSET.Edit Boot Order policies": "", "PRIVSET.Edit Boot Order policies for server profile": "Attach/detach Boot Order policies.\n", "PRIVSET.Edit Boot Order policies for server profile template": "Attach/detach Boot Order policies.\n", "PRIVSET.Edit Certificate Management policies": "", "PRIVSET.Edit Certificate Management policies for domain profile": "Attach/detach Certificate Management policies.\n", "PRIVSET.Edit Certificate Management policies for domain profile template": "Attach/detach Certificate Management policies.\n", "PRIVSET.Edit Certificate Management policies for server profile": "Attach/detach Certificate Management policies.\n", "PRIVSET.Edit Certificate Management policies for server profile template": "Attach/detach Certificate Management policies.\n", "PRIVSET.Edit Device Connector policies": "", "PRIVSET.Edit Device Connector policies for server profile": "Attach/detach Device Connector policies.\n", "PRIVSET.Edit Device Connector policies for server profile template": "Attach/detach Device Connector policies.\n", "PRIVSET.Edit Drive Security policies": "", "PRIVSET.Edit Drive Security policies for server profile": "Attach/detach Drive Security policies.\n", "PRIVSET.Edit Drive Security policies for server profile template": "Attach/detach Drive Security policies.\n", "PRIVSET.Edit Ethernet Adapter policies": "", "PRIVSET.Edit Ethernet Adapter policies for vNIC template": "Attach/detach Ethernet Adapter policies.\n", "PRIVSET.Edit Ethernet Network Control policies": "", "PRIVSET.Edit Ethernet Network Control policies for vNIC template": "Attach/detach Ethernet Network Control policies.\n", "PRIVSET.Edit Ethernet Network Group policies": "", "PRIVSET.Edit Ethernet Network Group policies for vNIC template": "Attach/detach Ethernet Network Group policies.\n", "PRIVSET.Edit Ethernet Network policies": "", "PRIVSET.Edit Ethernet QoS policies": "", "PRIVSET.Edit Ethernet QoS policies for vNIC template": "Attach/detach Ethernet QoS policies.\n", "PRIVSET.Edit FC Zone policies": "", "PRIVSET.Edit Fibre Channel Adapter policies": "", "PRIVSET.Edit Fibre Channel Adapter policies for vHBA template": "Attach/detach Fibre Channel Adapter policies.\n", "PRIVSET.Edit Fibre Channel Network policies": "", "PRIVSET.Edit Fibre Channel Network policies for vHBA template": "Attach/detach Fibre Channel Network policies.\n", "PRIVSET.Edit Fibre Channel QoS policies": "", "PRIVSET.Edit Fibre Channel QoS policies for vHBA template": "Attach/detach Fibre Channel QoS policies.\n", "PRIVSET.Edit Fibre Channel Zone policies for vHBA template": "Attach/detach Fibre Channel Zone policies.\n", "PRIVSET.Edit Firmware policies": "", "PRIVSET.Edit Firmware policies for server profile": "Attach/detach Firmware policies.\n", "PRIVSET.Edit Firmware policies for server profile template": "Attach/detach Firmware policies.\n", "PRIVSET.Edit Flow Control policies": "", "PRIVSET.Edit IMC Access policies": "", "PRIVSET.Edit IMC Access policies for chassis profile": "Attach/detach IMC Access policies.\n", "PRIVSET.Edit IMC Access policies for chassis profile template": "Attach/detach IMC Access policies.\n", "PRIVSET.Edit IMC Access policies for server profile": "As a Edit IMC Access policies for server profile user, you can adjust IMC access policies for server profiles.\nThis includes updating access settings and ensuring that configurations are correctly applied to servers.\n", "PRIVSET.Edit IMC Access policies for server profile template": "As a Edit IMC Access policies for server profile template user, you can adjust IMC access policies for server profile templates.\nThis includes updating access settings and ensuring that configurations are correctly applied to templates.\n", "PRIVSET.Edit IP pools": "", "PRIVSET.Edit IPMI Over LAN policies for server profile": "Attach/detach IPMI Over LAN policies.\n", "PRIVSET.Edit IPMI Over LAN policies for server profile template": "Attach/detach IPMI Over LAN policies.\n", "PRIVSET.Edit IPMI over LAN policies": "", "PRIVSET.Edit IQN pools": "Modify existing iSCSI Qualified Name (IQN) pools, optimizing IQN management.\n", "PRIVSET.Edit LAN Connectivity policies": "", "PRIVSET.Edit LAN Connectivity policies for server profile": "Attach/detach LAN Connectivity policies.\n", "PRIVSET.Edit LAN Connectivity policies for server profile template": "Attach/detach LAN Connectivity policies.\n", "PRIVSET.Edit LDAP policies": "", "PRIVSET.Edit LDAP policies for domain profile": "Attach/detach LDAP policies.\n", "PRIVSET.Edit LDAP policies for domain profile template": "Attach/detach LDAP policies.\n", "PRIVSET.Edit LDAP policies for server profile": "Attach/detach LDAP policies.\n", "PRIVSET.Edit LDAP policies for server profile template": "Attach/detach LDAP policies.\n", "PRIVSET.Edit LDAP servers": "Modify the configuration of existing LDAP servers by updating server address, port, authentication methods, and directory structures to ensure proper directory services and authentication.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Edit Link Aggregation policies": "As an Edit Link Aggregation Policy user, you can modify existing link aggregation policies, \nadjusting settings to optimize the performance and redundancy of combined network connections.\n", "PRIVSET.Edit Link Control policies": "As an Edit Link Control Policy user, you can modify existing link control policies, \nadjusting settings to enhance network link behavior and performance.\n", "PRIVSET.Edit Local User policies": "", "PRIVSET.Edit Local User policies for domain profile": "Attach/detach Local User policies.\n", "PRIVSET.Edit Local User policies for domain profile template": "Attach/detach Local User policies.\n", "PRIVSET.Edit Local User policies for server profile": "Attach/detach Local User policies.\n", "PRIVSET.Edit Local User policies for server profile template": "Attach/detach Local User policies.\n", "PRIVSET.Edit MAC Pools for vNIC template": "Attach/detach MAC Pools.\n", "PRIVSET.Edit MAC pools": "Modify existing MAC pools, optimizing MAC address management.\n", "PRIVSET.Edit Memory policies": "As an Edit Memory Policy user, you can modify existing memory policies.\n", "PRIVSET.Edit Memory policies for server profile": "Attach/detach Memory policies.\n", "PRIVSET.Edit Memory policies for server profile template": "Attach/detach Memory policies.\n", "PRIVSET.Edit Multicast policies": "", "PRIVSET.Edit NTP policies": "", "PRIVSET.Edit NTP policies for domain profile": "Attach/detach NTP policies.\n", "PRIVSET.Edit NTP policies for domain profile template": "Attach/detach NTP policies.\n", "PRIVSET.Edit NTP policies for server profile": "Attach/detach NTP policies.\n", "PRIVSET.Edit NTP policies for server profile template": "Attach/detach NTP policies.\n", "PRIVSET.Edit Network Connectivity policies": "", "PRIVSET.Edit Network Connectivity policies for domain profile": "Attach/detach LDAP policies.\n", "PRIVSET.Edit Network Connectivity policies for domain profile template": "Attach/detach Network Connectivity policies.\n", "PRIVSET.Edit Network Connectivity policies for server profile": "Attach/detach Network Connectivity policies.\n", "PRIVSET.Edit Network Connectivity policies for server profile template": "Attach/detach Network Connectivity policies.\n", "PRIVSET.Edit OAuth 2.0 grant type applications": "Modify settings of existing OAuth 2.0 grant type applications, including their grant types, permissions, and configurations.\n", "PRIVSET.Edit OS configuration links": "Modify the OS configuration file for automated and unattended OS installation on servers.\n", "PRIVSET.Edit OS image links": "Modify the image source of the operating system in the software repository, updating file share location and protocol (CIFS/NFS/HTTPS).\n", "PRIVSET.Edit Persistent Memory policies": "", "PRIVSET.Edit Persistent Memory policies for server profile": "Attach/detach Persistent Memory policies.\n", "PRIVSET.Edit Persistent Memory policies for server profile template": "Attach/detach Persistent Memory policies.\n", "PRIVSET.Edit Port policies": "", "PRIVSET.Edit Ports Configuration policies for domain profile": "Attach/detach Ports Configuration policies.\n", "PRIVSET.Edit Ports Configuration policies for domain profile template": "Attach/detach Ports Configuration policies.\n", "PRIVSET.Edit Power policies": "", "PRIVSET.Edit Power policies for chassis profile": "Attach/detach Power policies.\n", "PRIVSET.Edit Power policies for chassis profile template": "Attach/detach Power policies.\n", "PRIVSET.Edit Power policies for server profile": "Attach/detach Power policies.\n", "PRIVSET.Edit Power policies for server profile template": "Attach/detach Power policies.\n", "PRIVSET.Edit Resource pools": "Modify existing resource pools to optimize resource management.\n", "PRIVSET.Edit SAN Connectivity policies": "", "PRIVSET.Edit SAN Connectivity policies for server profile": "Attach/detach SAN Connectivity policies.\n", "PRIVSET.Edit SAN Connectivity policies for server profile template": "Attach/detach SAN Connectivity policies.\n", "PRIVSET.Edit SCU links": "Modify the Server Configuration Utility (SCU) for automated OS installation, editing file share locations using NFS, CIFS, or HTTP protocols.\n", "PRIVSET.Edit SD Card policies": "", "PRIVSET.Edit SD Card policies for server profile": "Attach/detach SD Card policies.\n", "PRIVSET.Edit SD Card policies for server profile template": "Attach/detach SD Card policies.\n", "PRIVSET.Edit SMTP policies": "", "PRIVSET.Edit SMTP policies for server profile": "Attach/detach SMTP policies.\n", "PRIVSET.Edit SMTP policies for server profile template": "Attach/detach SMTP policies.\n", "PRIVSET.Edit SNMP policies": "", "PRIVSET.Edit SNMP policies for chassis profile": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SNMP policies for chassis profile template": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SNMP policies for domain profile": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SNMP policies for domain profile template": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SNMP policies for server profile": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SNMP policies for server profile template": "Attach/detach SNMP policies.\n", "PRIVSET.Edit SSH policies": "", "PRIVSET.Edit SSH policies for server profile": "Attach/detach SSH policies.\n", "PRIVSET.Edit SSH policies for server profile template": "Attach/detach SSH policies.\n", "PRIVSET.Edit Scrub policies": "As an Edit Scrub Policy user, you can modify existing Scrub policies within the system \nto adjust virtual media access and management settings.\n", "PRIVSET.Edit Scrub policies for server profile": "As a Edit Scrub policies for server profile user, you can adjust scrub policies for Server Profiles.\n", "PRIVSET.Edit Scrub policies for server profile template": "As a Edit Scrub policies for server profile user, you can adjust scrub policies for Server Profiles.\n", "PRIVSET.Edit Serial Over LAN policies": "", "PRIVSET.Edit Serial Over LAN policies for server profile": "Attach/detach Serial Over LAN policies.\n", "PRIVSET.Edit Serial Over LAN policies for server profile template": "Attach/detach Serial Over LAN policies.\n", "PRIVSET.Edit Storage policies": "", "PRIVSET.Edit Storage policies for server profile": "Attach/detach Storage policies.\n", "PRIVSET.Edit Storage policies for server profile template": "Attach/detach Storage policies.\n", "PRIVSET.Edit Switch Control policies": "", "PRIVSET.Edit Switch Control policies for domain profile": "Attach/detach Switch Control policies.\n", "PRIVSET.Edit Switch Control policies for domain profile template": "Attach/detach Switch Control policies.\n", "PRIVSET.Edit Syslog policies": "", "PRIVSET.Edit Syslog policies for domain profile": "Attach/detach Syslog policies.\n", "PRIVSET.Edit Syslog policies for domain profile template": "Attach/detach Syslog policies.\n", "PRIVSET.Edit Syslog policies for server profile": "Attach/detach Syslog policies.\n", "PRIVSET.Edit Syslog policies for server profile template": "Attach/detach Syslog policies.\n", "PRIVSET.Edit System QoS policies": "", "PRIVSET.Edit System QoS policies for domain profile": "Attach/detach System QoS policies.\n", "PRIVSET.Edit System QoS policies for domain profile template": "Attach/detach System QoS policies.\n", "PRIVSET.Edit Thermal policies": "", "PRIVSET.Edit Thermal policies for chassis profile": "Attach/detach Thermal policies.\n", "PRIVSET.Edit Thermal policies for chassis profile template": "Attach/detach Thermal policies.\n", "PRIVSET.Edit Thermal policies for server profile": "Attach/detach Thermal policies.\n", "PRIVSET.Edit Thermal policies for server profile template": "Attach/detach Thermal policies.\n", "PRIVSET.Edit UUID pools": "Modify existing universally unique identifier (UUID) pools, optimizing UUID management.\n", "PRIVSET.Edit UUID pools for server profile": "As a Modify UUID Pool for Server Profile user, you can adjust UUID pools for server profiles.\nThis includes updating UUID settings and ensuring that configurations are correctly applied to servers.\n", "PRIVSET.Edit UUID pools for server profile template": "As a Modify UUID Pool for Server Profile Template user, you can adjust UUID pools for server profile templates.\nThis includes updating UUID settings and ensuring that configurations are correctly applied to templates.\n", "PRIVSET.Edit VLAN policies": "", "PRIVSET.Edit VSAN policies": "", "PRIVSET.Edit Virtual KVM policies": "", "PRIVSET.Edit Virtual KVM policies for server profile": "Attach/detach Virtual KVM policies.\n", "PRIVSET.Edit Virtual KVM policies for server profile template": "Attach/detach Virtual KVM policies.\n", "PRIVSET.Edit Virtual Media policies": "", "PRIVSET.Edit Virtual Media policies for server profile": "Attach/detach Virtual Media policies.\n", "PRIVSET.Edit Virtual Media policies for server profile template": "Attach/detach Virtual Media policies.\n", "PRIVSET.Edit WWNN or WWPN pools": "Modify existing WWNN or WWPN pools to optimize management.\n", "PRIVSET.Edit WWPN pools for vHBA template": "Attach/detach WWPN Pools.\n", "PRIVSET.Edit chassis profile general properties": "Edit name, description, organization and tag of chassis profiles.\n", "PRIVSET.Edit chassis profile policies": "Attach/detach the policies associated with chassis profiles.\n", "PRIVSET.Edit chassis profile template general properties": "Edit name, description, organization and tag of chassis profile templates.\n", "PRIVSET.Edit chassis profile template policies": "Attach/detach the policies associated with chassis profile templates.\n", "PRIVSET.Edit chassis profile templates": "Modify chassis profile templates to update and manage configuration settings for physical chassis.\n", "PRIVSET.Edit chassis profiles": "Edit chassis profiles to update and manage configuration settings for physical chassis.\n", "PRIVSET.Edit domain profile general properties": "Edit name, description, organization and tag for UCS domain profiles.\n", "PRIVSET.Edit domain profile policies": "Attach/detach the policies for domain profile.\n", "PRIVSET.Edit domain profile template general properties": "Edit name, description, organization and tag of domain profile templates.\n", "PRIVSET.Edit domain profile template policies": "Attach/detach the policies associated with domain profile templates.\n", "PRIVSET.Edit domain profile templates": "Modify existing chassis profile templates to update and manage configuration settings for domain.\n", "PRIVSET.Edit domain profiles": "Edit the settings and policies of domain profiles to update and optimize operations.\n", "PRIVSET.Edit external syslog servers": "Modify the configuration of existing external Syslog servers by adjusting settings and parameters to ensure effective log data collection and management.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Edit firmware links": "Modify the firmware source in the software repository by changing the file share location and protocol (NFS/CIFS/HTTP[S]).\n", "PRIVSET.Edit iSCSI Adapter policies": "", "PRIVSET.Edit iSCSI Boot policies": "", "PRIVSET.Edit iSCSI Boot policies for vNIC template": "Attach/detach iSCSI Boot policies.\n", "PRIVSET.Edit iSCSI Static Target policies": "As an Edit iSCSI Static Target Policy user, you can modify existing iSCSI static target policies, \nadjusting settings to enhance the management and performance of connections to specific iSCSI targets within the storage network.\n", "PRIVSET.Edit identity providers": "Modify the configuration of existing IdPs by updating settings, credentials, and trust relationships to maintain or enhance authentication and access management.\n", "PRIVSET.Edit integrated systems": "Edit the configuration of an existing integrated system.\n", "PRIVSET.Edit notification rule or webhook": "Modify existing notification rules, adjusting criteria and actions to refine how alerts and notifications are triggered and managed.\n", "PRIVSET.Edit server profile general properties": "Edit name, description, organization and tag of server profiles.\n", "PRIVSET.Edit server profile policies": "Attach/detach the policies associated with server profiles.\n", "PRIVSET.Edit server profile template general properties": "Edit name, description, organization and tag of server profile templates.\n", "PRIVSET.Edit server profile template policies": "Attach/detach the policies associated with server profile templates. \n", "PRIVSET.Edit server profile templates": "Edit, attach/detach policies associated with server profile templates.\n", "PRIVSET.Edit server profiles": "Edit, attach/detach the policies associated with server profiles.\n", "PRIVSET.Edit trusted IP ranges": "Edit the trusted IP ranges.\n", "PRIVSET.Edit vHBA template general properties": "Set or edit name, description, organization and tag of vHBA templates.\n", "PRIVSET.Edit vHBA template policies": "Attach/detach the policies and pools associated with vHBA templates.\n", "PRIVSET.Edit vHBA templates": "Edit vHBA templates to update and manage configuration settings for vHBA.\n", "PRIVSET.Edit vLAN Configuration policies for domain profile": "Attach/detach vLAN Configuration policies.\n", "PRIVSET.Edit vLAN Configuration policies for domain profile template": "Attach/detach vLAN Configuration policies.\n", "PRIVSET.Edit vNIC template general properties": "Set or edit name, description, organization and tag of vNIC templates.\n", "PRIVSET.Edit vNIC template policies": "Attach/detach the policies and pools associated with vNIC templates.\n", "PRIVSET.Edit vNIC templates": "Edit the settings and policies of vNIC Templates.\n", "PRIVSET.Edit vSAN Configuration policies for domain profile": "Attach/detach vSAN Configuration policies.\n", "PRIVSET.Edit vSAN Configuration policies for domain profile template": "Attach/detach vSAN Configuration policies.\n", "PRIVSET.Enable and disable API keys": "As a user with the ability to Enable or Disable API Keys, you can Activate & deactivate API keys, restricting access to the system's services.\n", "PRIVSET.Enable and disable OAuth 2.0 grant type applications": "Activate or deactivate OAuth 2.0 grant type applications to control their availability for authentication and authorization processes.\n", "PRIVSET.Enable and disable ports": "Activate or deactivate network ports to manage connectivity.\n", "PRIVSET.Enable or Disable Port Channels": "As an Enable or Disable Port user, you can activate or deactivate network ports, controlling their operational status to manage network connectivity and configuration.\n", "PRIVSET.Enable subscription information": "Obtain subscription details such as usage, status, and next expiration date.\n", "PRIVSET.Enable subscriptions": "Enable visibility of subscription details in the Intersight appliance.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Enable/disable IP access management": "Enable or disable IP access management.\n", "PRIVSET.Enable/disable tunneled vKVM": "Enable or disable tunneled virtual keyboard, video, and mouse (vKVM) on servers.\n", "PRIVSET.Enter maintenance modes": "Enter maintenance mode for a VM host.\n", "PRIVSET.Ethernet Adapter policies": "Configure Ethernet adapter settings, impacting network properties such as MAC address pools, speed, and media modes.\n", "PRIVSET.Ethernet Network Control policies": "Manage server discoverability through protocols like Cisco Discovery Protocol and Link Layer Discovery Protocol.\n", "PRIVSET.Ethernet Network Group policies": "Manage QinQ VLAN and native VLAN settings.\n", "PRIVSET.Ethernet Network policies": "Manage VLAN mode and default VLAN settings.\n", "PRIVSET.Ethernet QoS policies": "Assigns a system class to outgoing traffic for a vNIC, determining the quality of service.\n", "PRIVSET.Execute Workflows": "A set of privileges that allow the users to execute workflows and manage running workflows in IO.\n", "PRIVSET.Exit maintenance modes": "Exit maintenance mode for a VM host.\n", "PRIVSET.Explorations": "Manage and configure explorations.\n", "PRIVSET.Explorer": "Manage and configure the metric explorer.\n", "PRIVSET.External Syslog Administrator": "As an External Syslog Administrator, you can configure an external syslog server on an on-prem appliance.\n", "PRIVSET.FC Zone policies": "Manage FC target zoning type and target settings.\n", "PRIVSET.Fabric Interconnects": "A set of privileges that allows to perform operations related to Fabric Interconnect e.g. view fabric interconnect summary\nor detailed information about fabric connect. Fabric Interconnect privilege set is the top level privilege set of other\nprivilege set(s) which are mapped to privileges related to Fabric Interconnect.\n", "PRIVSET.Fabric evacuation": "Initiate fabric resource evacuation for maintenance.\n", "PRIVSET.Fibre Channel Adapter policies": "Manages host-side behaviour of Fibre Channel adapters, including error recovery and performance settings.\n", "PRIVSET.Fibre Channel Network policies": "Manage the default VLAN and VSAN ID settings.\n", "PRIVSET.Fibre Channel QoS policies": "Manage network traffic prioritization in Fibre Channel environments by assigning different levels of service (Platinum, Gold, Silver, Bronze).\n", "PRIVSET.Firmware links": "Manage firmware links.\n", "PRIVSET.Firmware policies": "Manage the current firmware, including option to exclude upgrade of drives and storage controllers.\n", "PRIVSET.Flow Control policies": "Configure the Priority Flow Control (PFC) for each port.\n", "PRIVSET.Generate API keys": "Create new API keys to enable secure access and interaction with system APIs for integration and automation purposes.\n", "PRIVSET.Generic": "Manage the general configuration settings of the appliance.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Global Read Privileges": "A set of privileges that are common to all privilege sets. These are read-only privileges that will be common to all the hierarchial privileges\n", "PRIVSET.Global System Privileges": "A set of privileges that are common to all system packaged, system defined and internal privilege sets. Global System Privileges will not be part of the user created privilege sets.\n", "PRIVSET.Global Write Privileges": "A set of privileges that are common to all privilege sets. These are write privileges that will be common to all the hierarchial privileges\n", "PRIVSET.HCI Cluster Administrator": "As an HCI Cluster Administrator, you can view and manage HCI Clusters,\nview all the cluster dashboard widgets, view cluster details. This role does not include the ability to claim a device.\n", "PRIVSET.HCI Cluster Operator": "As an HCI Cluster Operator, you can view and manage HCI Clusters, view all the cluster dashboard widgets, view cluster details.\nThis role provides view only access to hypervisor, storage related inventory and dashboards. This role does not include the ability to claim a device.\n", "PRIVSET.HCI Clusters": "A set of privileges that allows the access to manage HCI clusters.\n", "PRIVSET.Hosts": "Manage and configure VM hosts.\n", "PRIVSET.HyperFlex Cluster": "A set of privileges that allows the access to manage HyperFlex clusters.\n", "PRIVSET.HyperFlex Cluster Access Operator": "As a HyperFlex Cluster Access Operator, you can cross launch CLI and HXConnect.\n", "PRIVSET.HyperFlex Cluster Administrator": "As a HyperFlex Cluster Administrator, you can create, edit, deploy, and manage HyperFlex Clusters,\nview all the cluster dashboard widgets, view cluster details, create HyperFlex policies and profiles,\nexecute capacity planning, and launch HyperFlex Connect. This role does not include the ability to claim a\ndevice. It also allows the user to run workflows, manage VMs on HyperFlexAP, and manage connected storage.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.HyperFlex Cluster Advanced Security": "A set of privileges that allows the configuration and deployment of advanced security profiles.\n", "PRIVSET.HyperFlex Cluster Backups": "A set of privileges that allows the configuration and deployment of HyperFlex Cluster backup policy and restore.\n", "PRIVSET.HyperFlex Cluster Capacity Planning": "A set of privileges that allows users to execute capacity planning.\n", "PRIVSET.HyperFlex Cluster Data Protection Administrator": "As a HyperFlex Cluster Data Protection Administrator, you can perform N:1 backups.\n", "PRIVSET.HyperFlex Cluster Lifecycle Administrator": "As a HyperFlex Cluster Lifecycle Administrator, you can install, expand, upgrade a HX cluster, execute capacity\nplanning, OS installation, VC plugin installation, security hardening, and launch HyperFlex Connect as admin.\n", "PRIVSET.HyperFlex Cluster Operations": "A set of privileges that allows the viewing of cluster operation related functionality.\n", "PRIVSET.HyperFlex Cluster Operator": "As a HyperFlex Cluster Operator, you can perform health checks.\nHowever, you cannot change cluster configuration.\n", "PRIVSET.HyperFlex Cluster Profiles": "A set of privileges that allows to manage HyperFlex policies and profiles.\n", "PRIVSET.HyperFlex Cluster Storage Administrator": "As a HyperFlex Cluster Storage Administrator, you can perform datastore, iSCSI, and storage container CRUD operations.\n", "PRIVSET.HyperFlex Cluster Syslog Administrator": "As a HyperFlex Cluster Syslog Administrator, you can configure the external HX Syslog profile.\n", "PRIVSET.HyperFlex Cluster Syslog Profile Control": "This allows write access to the Remote Syslog Advanced Security Profile\n", "PRIVSET.HyperFlex Cluster System Administrator": "As a HyperFlex Cluster System Administrator, you can perform most of the system administrator tasks.\n", "PRIVSET.HyperFlex Cluster System Operator": "As a HyperFlex Cluster System Operator, you can perform encryption, health checks, and post-install tasks.\n", "PRIVSET.HyperFlex Key Encryption": "A set of privileges that allows users to configure encryption keys.\n", "PRIVSET.HyperFlex View Only": "A set of privileges that grants view only to HyperFlex related functionality\n", "PRIVSET.Hypervisors": "A set of privileges that allows the access to detailed hypervisor information and to perform hypervisor related actions.\nHypervisors privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges\nrelated to hypervisors.\n", "PRIVSET.IMC Access policies": "Configure network settings and associates IP addresses with servers, supporting both in-band and out-of-band management.\n", "PRIVSET.IP access management": "Manage and allow access to Intersight, only for users from trusted IP addresses.\n", "PRIVSET.IP block mapping": "Manage the mapping of IP blocks on servers.\n", "PRIVSET.IPMI over LAN policies": "Define protocols for interfacing with the server's service processor via the Intelligent Platform Management Interface (IPMI).\n", "PRIVSET.IQN block mapping": "Manage the pool containing iSCSI Qualified Names (IQNs) used as initiator identifiers by iSCSI vNICs.\n", "PRIVSET.Import foreign configurations": "Import and apply foreign configurations, integrating external storage setups.\n", "PRIVSET.Import server profiles": "Import server profiles from external sources.\n", "PRIVSET.Install operating systems": "Install and configure an operating system on a server to make it operational.\n", "PRIVSET.Install updates": "Apply and execute software updates to ensure the latest features, improvements, and security patches are installed on the system.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Integrated Systems Administrator": "As an Integrated Systems Administrator, you can perform all actions related to Integrated Systems (e.g., FlexPod) like\ncreate/edit/delete of an Integrated System. In addition you can perform administrative and management tasks related to \ndevices (including claim), servers, server profiles, UCS domain, switch profiles, hypervisors, network/SAN switches, \nstorage devices. Also, you can define workflow and task definitions and can execute them and view workflow executions.\n", "PRIVSET.Integrated Systems Operator": "As an Integrated Systems Operator, you can view Integrated Systems (e.g., FlexPod) and can run inventory based actions \n(e.g., Interoperability check). In addition you can view devices, servers, server profiles, UCS domain, switch profiles,\nhypervisors, network/SAN switches, storage devices and workflows. This role does not include the ability to claim a target.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a target.\n", "PRIVSET.Integrated systems": "Manage and configure integrated systems.\n", "PRIVSET.Kubernetes Administrator": "As a Kubernetes Administrator, you can create, edit, deploy, and manage Kubernetes Clusters. You can also\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview and manage storage devices associated with the Kubernetes clusters. The capability to view and execute\nworkflows against the Kubernetes clusters is also granted. It also allows\nthe user to run workflows to manage VMs on hypervisor endpoints, and manage connected storage, and creat/view ip pools.\nThis role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Kubernetes Operator": "As a Kubernetes Operator, you can view Kubernetes Clusters. You can also\nview all the cluster dashboard widgets, and view cluster details. In addition, you also have privileges to\nview storage devices associated with the Kubernetes clusters. The capability to view\nworkflows is also granted. It also allows the user to view VMs on hypervisor endpoints.\nThis role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.LAN Connectivity policies": "Manage the network settings for server connectivity within a Local Area Network (LAN).\n", "PRIVSET.LDAP policies": "Attach/detach LDAP policies.\n", "PRIVSET.Launch CLI as admin": "As a Launch CLI user, you can access the command-line interface (CLI) for managing and configuring UCS systems, allowing for command execution and system administration tasks.\n", "PRIVSET.Launch CLI as read-only": "As a Launch CLI as read-only user, you can access the command-line interface (CLI) for UCS systems with read-only permissions, allowing you to view system configurations and status without making changes.\n", "PRIVSET.Launch Endpoint Management Interfaces": "Launch Endpoint Management Interfaces.\n", "PRIVSET.Launch IMC as admin": "Manage servers through the IMC interface with administrative privileges.\n", "PRIVSET.Launch IMC as read-only": "Access servers via the IMC interface with read-only permissions.\n", "PRIVSET.Launch UCS Manager as admin": "Access and manage UCS Manager with full privileges.\n", "PRIVSET.Launch UCS Manager as read-only": "View UCS Manager interface without changes.\n", "PRIVSET.Launch VM consoles": "Launch the console for a virtual machine (VM).\n", "PRIVSET.Launch host consoles": "Launch the console for a VM host.\n", "PRIVSET.Launch tunneled vKVM sessions": "Allows access to a server's KVM console even if the user is not in the same network as the server and the KVM IP is not reachable.\n", "PRIVSET.Launch vKVM": "Allows to launch the virtual keyboard, video, and mouse (KVM) console directly for Fabric Interconnect-attached and standalone servers.\n", "PRIVSET.Launch vKVM sessions": "Allows to launch the virtual keyboard, video, and mouse (KVM) console directly for Fabric Interconnect-attached and standalone servers.\n", "PRIVSET.Licensing": "Manage and configure licensing.\n", "PRIVSET.Link Aggregation policies": "Configure throughput and redundancy using Link Aggregation Control Protocol (LACP) for efficient failure detection.\n", "PRIVSET.Link Control policies": "Configure Unidirectional Link Detection (UDLD) Admin state and mode.\n", "PRIVSET.Local User policies": "Configure local user preferences, and password properties.\n", "PRIVSET.Location Management": "Users can view and manage locations. This role provides location management privileges to an user.\n", "PRIVSET.Locator LEDs": "Control the locator LED functionality to visually locate and identify specific hardware components within a rack.\n", "PRIVSET.Manage API Keys": "Manage API Keys.\n", "PRIVSET.Manage Access and Permissions": "Manage access control rules and permissions.\n", "PRIVSET.Manage Auth Tokens": "Manage Authentication and Authorization Tokens.\n", "PRIVSET.Manage Exports": "A set of privileges that allow the users to export Intersight managed objects.\n", "PRIVSET.Manage External Syslog": "Manage External Syslog.\n", "PRIVSET.Manage Fabric Interconnects": "Manage Fabric Interconnects.\n", "PRIVSET.Manage Functions": "A set of privileges that allows the users to manage serverless functions.\n", "PRIVSET.Manage Geo Locations": "A set of privileges that allows the users to manage geo locations.\n", "PRIVSET.Manage HCI Clusters": "Manage HyperConverged Infrastructure Clusters.\n", "PRIVSET.Manage HyperFlex Cluster Profiles": "Manage HyperFlex Cluster Profiles.\n", "PRIVSET.Manage HyperFlex Clusters": "Manage HyperFlex Clusters.\n", "PRIVSET.Manage HyperFlex Syslog": "Manage HyperFlex Advanced Syslog Configuration\n", "PRIVSET.Manage Hypervisors": "A set of privileges that allow the users to execute workflows related to hypervisor and virtual machines management.\n", "PRIVSET.Manage Identity Providers": "Manage Single Sign On identity providers.\n", "PRIVSET.Manage Imports": "A set of privileges that allow the users to import Intersight managed objects.\n", "PRIVSET.Manage Language Runtimes": "A set of privileges that allows the users to manage language runtimes for serverless functions.\n", "PRIVSET.Manage Nexus Config": "A set of privileges that allows users to add, remove, or alter site templates and policies.\n", "PRIVSET.Manage Nexus Sites": "A set of privileges that allows users to add, remove, or alter sites.\n", "PRIVSET.Manage Organizations": "A set of privileges that allows the access to manage Organizations.\n", "PRIVSET.Manage Server Profiles": "Manage server profiles.\n", "PRIVSET.Manage Servers": "Manage Servers.\n", "PRIVSET.Manage ServiceItem Instances.": "A set of privileges that allow the users to manage ServiceItem Instances.\n", "PRIVSET.Manage Sessions": "Manage user login sessions.\n", "PRIVSET.Manage Storage Arrays": "A set of privileges that allow the user to execute workflows related to storage arrays.\n", "PRIVSET.Manage Switch Profiles": "Manage Switch Profiles.\n", "PRIVSET.Manage Tags": "A set of privileges that allows the users to manage tag definitions.\n", "PRIVSET.Manage Techsupport Bundles": "Collect and download techsupport bundles.\n", "PRIVSET.Manage Telemetry": "Manage Telemetry allows [READ of broker information](http://druid.io/docs/latest/operations/api-reference.html#broker).\n", "PRIVSET.Manage Unified Edge": "Manage Unified Edge.\n", "PRIVSET.Manage Unified Edge Profiles": "Manage Unified Edge Profiles.\n", "PRIVSET.Manage Workflow Definitions": "A set of privileges that allow the users to manage workflow and custom data type definitions.\n", "PRIVSET.Manage Workload Definitions": "A set of privileges that allow the users to manage workload definitions.\n", "PRIVSET.Manage Workload Deployments": "A set of privileges that allow the users to manage workload deployments.\n", "PRIVSET.Manage alarm suppression": "Suppress and unsuppress alarms.\n", "PRIVSET.Manage products": "Select products to be enabled for the Intersight account.\n", "PRIVSET.Manage targets": "Manage targets in the system by adding, claiming, and unclaiming.\n", "PRIVSET.Manage tech support bundles": "Add a new tech support bundle.\n", "PRIVSET.Memory policies": "Attach/detach Memory policies.\n", "PRIVSET.Modify security keys": "Change security keys to update encryption or access controls.\n", "PRIVSET.Monitor audit logs": "View and analyze audit logs.\n", "PRIVSET.Multicast policies": "Configure the snooping, quierer and source IP proxy states.\n", "PRIVSET.NTP policies": "Attach/detach NTP policies.\n", "PRIVSET.Network Administrator": "As a Network Administrator, you can create, update, delete and view the Managed Network switch objects. \nThe capability to view and execute workflows against the Network switches is also granted. \n\nThis role does not include the ability to claim a target. You must have a Device Technician,\nDevice Administrator, or an Account Administrator role to claim a target.\n", "PRIVSET.Network Connectivity policies": "Configure and assign IPv4 and IPv6 addresses, enable dynamic DNS.\n", "PRIVSET.Network Operator": "As a Network Operator, you can view the Managed Network switch objects. The capability to view workflows against the \nNetwork switches is also granted. This role does not include the ability to claim a target.\n\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to\nclaim a target.\n", "PRIVSET.Nexus Administrator": "As a Nexus Administrator, you have the privileges to perform all Nexus related operations. This includes\nclaiming devices, view license, updating policy configuration, and monitoring the system.\n", "PRIVSET.Nexus Analyst": "As a Nexus Analyst, you can run and update the available Nexus Cloud analyzes such as Sustainability, Conformance, Compliance, and others.\n", "PRIVSET.Nexus Config Administrator": "As a Nexus Config Administrator, you can create or modify policy configuration, view license and can initiate the\nworkflow that will activate policy changes.\n\nThis role does not allow you to claim or remove devices.\n", "PRIVSET.Nexus Observer": "As a Nexus Observer, you can generally view the state of all devices. Additional items\ninclude things like viewing configured policies, license status and monitoring active flows. This role does\nnot include any permission which allows the system to be changed.\n", "PRIVSET.Notifications and webhooks": "Manage notification rules.\n", "PRIVSET.OAuth 2.0 applications": "Manage OAuth 2.0 applications, including creating, editing, enabling/disabling, and deleting them.\n", "PRIVSET.OAuth2 tokens": "Manage OAuth 2.0 tokens, including deleting tokens to control access to the system's resources.\n", "PRIVSET.OS configuration files": "Manage OS configuration files.\n", "PRIVSET.OS image links": "Manage OS image links.\n", "PRIVSET.Operate": "Access and operate physical servers, chassis, and domains, along with their respective profiles and pools of Intersight Infrastructure Services.\n", "PRIVSET.Operate IP pools": "Manage IP pools, including creation and modification.\n", "PRIVSET.Operate IQN pools": "As an IQN Pool user, you can create, manage, and delete IQN pools to organize and allocate IQNs for network storage resources efficiently.\n", "PRIVSET.Operate MAC pools": "Manage MAC pools, including creation and modification.\n", "PRIVSET.Operate Resource pools": "Manage resource pools by creating, modifying, deleting pools, and handling resource allocation within them.\n", "PRIVSET.Operate UUID pools": "Manage UUID pools by creating, modifying, deleting, and handling the allocation and reservation of UUIDs within those pools.\n", "PRIVSET.Operate WWNN and WWPN pools": "Manage world wide node names (WWNNs) or world wide port name (WWPNs) pools.\n", "PRIVSET.Operate chassis profiles": "Operate chassis profiles, deploying and assigning profiles.\n", "PRIVSET.Operate domain profiles": "Manage domain profiles, deploying and assigning them.\n", "PRIVSET.Operate physical chassis": "Perform chassis operations like power cycling and resetting.\n", "PRIVSET.Operate physical domains": "Manage physical domain operations related to hardware.\n", "PRIVSET.Operate physical server": "Manage physical server operations like powering on/off and resetting. This involves several key actions: server power management, virtual network and host bus adapters (vNIC/vHBA), server storage operations, system maintenance: Covers tasks such as resetting the CMOS, virtual KVM, monitoring and metrics.\n", "PRIVSET.Operate pools": "Manage resource pool operations like attaching or detaching.\n", "PRIVSET.Operate server power": "Manage server power actions. \n", "PRIVSET.Operate server profile": "Manage server profile operations like deployment and activation.\n", "PRIVSET.Operate server storage": "Operate server storage, including clearing configurations and managing security keys.\n", "PRIVSET.Operate server system": "Perform server system operations like rebooting and resetting CMOS.\n", "PRIVSET.Operate server vHBAs": "Perform operations on virtual host bus adapters (vHBAs), including enabling, disabling, and resetting.\n", "PRIVSET.Operate server vNICs": "Perform operations on virtual network interface cards (vNICs), including enabling, disabling, and resetting.\n", "PRIVSET.Organizations": "A set of privileges that allows the access to manage Organizations.\n", "PRIVSET.Persistent Memory policies": "Configure security, goals, and namespaces for persistent memory modules, ensuring data retention across power cycles.\n", "PRIVSET.Port policies": "Manage Fabric Interconnect ports, including port roles, types (Ethernet or Fibre Channel), and connection modes.\n", "PRIVSET.Power cycle chassis slots": "Power cycle chassis slots to refresh components.\n", "PRIVSET.Power policies": "Manage power settings for FI-attached servers and chassis, including profiling and priority.\n", "PRIVSET.Read Chassis Profiles and Chassis Profile Templates": "A set of privileges that allows read access to chassis profiles and chassis profile templates.\n", "PRIVSET.Read Domain Profiles and Domain Profile Templates": "A set of privileges that allows read access to domain profiles and domain profile templates.\n", "PRIVSET.Read Organizations": "As a Read Organizations user, you can view the configuration and status of the organization without making any modifications.\n", "PRIVSET.Read Server Profiles and Server Profile Templates": "A set of privileges that allows read access to server profiles and server profile templates.\n", "PRIVSET.Read Workflows": "As a Read Workflows user, you can view the configuration and status of workflows without making any modifications.\n", "PRIVSET.Read all API keys in the account": "Read-only access to configuration and status of all API keys associated with the account.\n", "PRIVSET.Read all OAuth apps in the account": "Read-only access to configuration and status of all OAuth tokens associated with the account.\n", "PRIVSET.Read-Only": "A set of privileges that provides read-only access to services and resources in Intersight.\n", "PRIVSET.Read-only": "Read-only access to configuration and status of all Intersight Infrastructure Services.\n", "PRIVSET.Read-only Adapter Configuration policies": "Read-only access to configuration and status of Adapter Configuration policies.\n", "PRIVSET.Read-only AuditD policies": "Read-only access to configuration and status of AuditD policies.\n", "PRIVSET.Read-only BIOS policies": "Read-only access to configuration and status of BIOS policies.\n", "PRIVSET.Read-only Boot Order policies": "Read-only access to configuration and status of Boot policies.\n", "PRIVSET.Read-only CLI policies": "Read-only access to configuration and status of CLI policies.\n", "PRIVSET.Read-only Certificate Management policies": "Read-only access to configuration and status of Certificate Management policies.\n", "PRIVSET.Read-only Device Connector Policies": "Read-only access to configuration and status of Device Connector policies.\n", "PRIVSET.Read-only Drive Security policies": "Read-only access to configuration and status of Drive Security policies.\n", "PRIVSET.Read-only Ethernet Adapter policies": "Read-only access to configuration and status of Ethernet Adapter policies.\n", "PRIVSET.Read-only Ethernet Network Control policies": "Read-only access to configuration and status of Ethernet Network Control policies.\n", "PRIVSET.Read-only Ethernet Network Group policies": "Read-only access to configuration and status of Ethernet Network Group policies.\n", "PRIVSET.Read-only Ethernet Network policies": "Read-only access to configuration and status of Ethernet Network policies.\n", "PRIVSET.Read-only Ethernet QoS policies": "Read-only access to configuration and status of Ethernet QoS policies.\n", "PRIVSET.Read-only FC Zone policies": "Read-only access to configuration and status of FC Zone policies.\n", "PRIVSET.Read-only Fabric Interconnects": "Read-only access to configuration and status of fabric interconnects (FIs).\n", "PRIVSET.Read-only Fibre Channel Adapter policies": "As a Read-only Fibre Channel Adapter Policy user, you can view the configuration and status of Fibre Channel adapter policies without making any modifications.\n", "PRIVSET.Read-only Fibre Channel Network policies": "Read-only access to configuration and status of Fibre Channel Network policies.\n", "PRIVSET.Read-only Fibre Channel QoS policies": "Read-only access to configuration and status of Fibre Channel QoS policies.\n", "PRIVSET.Read-only Firmware policies": "Read-only access to configuration and status of Firmware policies.\n", "PRIVSET.Read-only Flow Control policies": "Read-only access to configuration and status of Flow Control policies.\n", "PRIVSET.Read-only HyperFlex cluster profiles": "Read-only access to configuration and status of HyperFlex Cluster Profiles.\n", "PRIVSET.Read-only HyperFlex clusters": "Read-only access to configuration and status of HyperFlex (HX) clusters.\n", "PRIVSET.Read-only IMC Access policies": "Read-only access to configuration and status of IMC Access policies.\n", "PRIVSET.Read-only IP pools": "Read-only access to configuration and status of IP pools.\n", "PRIVSET.Read-only IPMI over LAN policies": "Read-only access to configuration and status of IPMI over LAN policies.\n", "PRIVSET.Read-only IQN pools": "Read-only access to configuration and status of IQN pools.\n", "PRIVSET.Read-only Kubernetes cluster profiles": "Read-only access to configuration and status of Kubernetes Cluster Profiles.\n", "PRIVSET.Read-only LAN Connectivity policies": "Read-only access to configuration and status of LAN Connectivity policies.\n", "PRIVSET.Read-only LDAP policies": "As a LDAP Policy user, you can view the configuration and status of system QoS policies without making any modifications.\n", "PRIVSET.Read-only Link Aggregation policies": "Read-only access to configuration and status of Link Aggregation policies.\n", "PRIVSET.Read-only Link Control policies": "Read-only access to configuration and status of Link Control policies.\n", "PRIVSET.Read-only Local User policies": "Read-only access to configuration and status of Local User policies.\n", "PRIVSET.Read-only MAC pools": "Read-only access to configuration and status of MAC pools.\n", "PRIVSET.Read-only Memory policies": "As a Read-only Memory Policy user, you can view the configuration and status of Memory policies without making any modifications.\n", "PRIVSET.Read-only Multicast policies": "Read-only access to configuration and status of Multicast policies.\n", "PRIVSET.Read-only NTP policies": "Read-only access to configuration and status of NTP policies.\n", "PRIVSET.Read-only Network Connectivity policies": "Read-only access to configuration and status of Network Connectivity policies.\n", "PRIVSET.Read-only Persistent Memory policies": "Read-only access to configuration and status of Persistent Memory policies.\n", "PRIVSET.Read-only Port policies": "Read-only access to configuration and status of Port policies.\n", "PRIVSET.Read-only Power policies": "Read-only access to configuration and status of Power policies.\n", "PRIVSET.Read-only SAN Connectivity policies": "Read-only access to configuration and status of SAN Connectivity policies.\n", "PRIVSET.Read-only SD Card policies": "Read-only access to configuration and status of SD Card policies.\n", "PRIVSET.Read-only SMTP policies": "Read-only access to configuration and status of SMTP policies.\n", "PRIVSET.Read-only SNMP policies": "Read-only access to configuration and status of SNMP policies\n", "PRIVSET.Read-only SOL policies": "Read-only access to configuration and status of SOL policies.\n", "PRIVSET.Read-only SSH policies": "Read-only access to configuration and status of SSH policies.\n", "PRIVSET.Read-only SSL Certificates": "As a Read-only SSL Certificates user, you can view the configuration and status of SSL certificates without making any modifications.\n", "PRIVSET.Read-only Scrub policies": "As a Read-only Scrub Policy user, you can view the configuration and status of Scrub policies without making any modifications.\n", "PRIVSET.Read-only Storage policies": "Read-only access to configuration and status of Storage policies.\n", "PRIVSET.Read-only Switch Control policies": "Read-only access to configuration and status of Switch Control policies.\n", "PRIVSET.Read-only Syslog policies": "Read-only access to configuration and status of Syslog policies.\n", "PRIVSET.Read-only System QoS policies": "Read-only access to configuration and status of System QoS policies.\n", "PRIVSET.Read-only Thermal policies": "Read-only access to configuration and status of Thermal policies.\n", "PRIVSET.Read-only UCS chassis profile templates": "Read-only access to configuration and status of UCS Chassis Profile templates.\n", "PRIVSET.Read-only UCS chassis profiles": "Read-only access to configuration and status of UCS Chassis Profiles.\n", "PRIVSET.Read-only UCS domain profile templates": "Read-only access to configuration and status of UCS Domain Profile templates.\n", "PRIVSET.Read-only UCS domain profiles": "Read-only access to configuration and status of UCS Domain Profiles.\n", "PRIVSET.Read-only UCS server profile templates": "Read-only access to configuration and status of UCS Server Profile templates.\n", "PRIVSET.Read-only UCS server profiles": "Read-only access to configuration and status of UCS Server Profiles.\n", "PRIVSET.Read-only UUID pools": "Read-only access to configuration and status of UUID pools.\n", "PRIVSET.Read-only VLAN policies": "Read-only access to configuration and status of VLAN policies.\n", "PRIVSET.Read-only VMs": "Read-only access to configuration and status of virtual machines (VMs).\n", "PRIVSET.Read-only VSAN policies": "Read-only access to configuration and status of VSAN policies.\n", "PRIVSET.Read-only Virtual KVM policies": "Read-only access to configuration and status of Virtual KVM policies.\n", "PRIVSET.Read-only WWNN and WWPN pools": "Read-only access to configuration and status of WWNN or WWPN pools.\n", "PRIVSET.Read-only all advisories": "As a Read-only Advisories user, you can view the configuration and status of all advisories without making any modifications.\n", "PRIVSET.Read-only all alarms": "Read-only access to configuration and status of all alarms.\n", "PRIVSET.Read-only all audit logs": "Read-only access to configuration and details of all audit logs.\n", "PRIVSET.Read-only all compute policies": "Read-only access to configuration and status of Compute policies.\n", "PRIVSET.Read-only all management policies": "Read-only access to configuration and status of all Management policies.\n", "PRIVSET.Read-only all network policies": "Read-only access to configuration and status of all Network policies.\n", "PRIVSET.Read-only all policies": "Read-only access to configuration and status of all policies.\n", "PRIVSET.Read-only all storage policies": "Read-only access to configuration and status of Storage policies.\n", "PRIVSET.Read-only chassis": "Read-only access to configuration and status of chassis.\n", "PRIVSET.Read-only hosts": "As a Read-only Hosts user, you can view the configuration and status of hosts without making any modifications.\n", "PRIVSET.Read-only iSCSI Adapter policies": "Read-only access to configuration and status of iSCSI Adapter policies.\n", "PRIVSET.Read-only iSCSI Boot policies": "Read-only access to configuration and status of iSCSI Boot policies.\n", "PRIVSET.Read-only iSCSI Static Target policies": "Read-only access to configuration and status of iSCSI Static Target policies.\n", "PRIVSET.Read-only integrated systems": "Read-only access to configuration and status of integrated systems.\n", "PRIVSET.Read-only licensing": "As a Read-only licensing user, you can view the configuration and status of licensing without making any modifications.\n", "PRIVSET.Read-only metrics explorations": "Read-only access to configuration and status of metrics explorations.\n", "PRIVSET.Read-only networking": "Read-only access to configuration and status of networking settings.\n", "PRIVSET.Read-only pools": "Read-only access to configuration and status of all pools.\n", "PRIVSET.Read-only profiles": "Read-only access to configuration and status of all Profiles.\n", "PRIVSET.Read-only resource pools": "Read-only access to configuration and status of Resource pools.\n", "PRIVSET.Read-only servers": "Read-only access to configuration and status of servers.\n", "PRIVSET.Read-only software repository": "As a Red-only Software Repository user, you can view the configuration and status of the software repository without making any modifications.\n", "PRIVSET.Read-only storage": "Read-only access to configuration and status of storage.\n", "PRIVSET.Read-only targets": "Read-only access to configuration and status of targets.\n", "PRIVSET.Read-only tech support bundles": "Read-only access to configuration and status of Tech Support Bundles\n", "PRIVSET.Read-only templates": "Read-only access to configuration and status of all templates.\n", "PRIVSET.Read-only vHBA templates": "Read-only access to configuration and status of vHBA templates.\n", "PRIVSET.Read-only vMedia policies": "Read-only access to configuration and status of vMedia policies.\n", "PRIVSET.Read-only vNIC templates": "Read-only access to configuration and status of vNIC templates.\n", "PRIVSET.Reboot Fabric Interconnect": "As a Reboot Fabric Interconnect user, you can restart the fabric interconnect, allowing for system updates, configuration changes, or recovery from issues.\n", "PRIVSET.Reboot management controllers": "Restart the management controller of a server.\n", "PRIVSET.Recommission Fabric Extender (FEX)": "Reactivate and restore a previously decommissioned Fabric Extenders (FEX), reestablishing connections and updating the system status.\n", "PRIVSET.Recommission chassis": "Reactivate and restore previously decommissioned chassis.\n", "PRIVSET.Recommission servers": "Bring a previously decommissioned server back into operational status. Allows read access to Fabric Interconnect.\n", "PRIVSET.Rediscover Fabric Extender (FEX)": "As a Rediscover Fabric Extender user, you can initiate a rediscovery process for fabric extenders,\n", "PRIVSET.Rediscover chassis": "Initiate a process to re-scan and identify chassis in the network, updating their status and configurations.\n", "PRIVSET.Rediscover servers": "Initiate a process to re-scan and identify servers in the network, updating their status and configurations.\n", "PRIVSET.Regenerate domain names": "Refresh or recreate a domain name within the system, updating its configuration or resolving issues related to network addressing and resource identification.\n", "PRIVSET.Register licenses": "Register Intersight licenses with Cisco Smart Licensing.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Reject Publish Requests": "Reject Publish Requests\n", "PRIVSET.Remove Fabric Extender (FEX)": "Safely disconnect and remove Fabric Extenders (FEX) from the system, ensuring proper management of dependencies.\n", "PRIVSET.Remove chassis": "Safely disconnect and remove chassis, ensuring all dependencies are managed.\n", "PRIVSET.Remove servers": "Disconnect the server from the network, erase all data, and update inventory records to reflect the change.\n", "PRIVSET.Renew licenses": "Update the Intersight license to include any changes on Cisco Smart Software Manager.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Replace Fabric Interconnect": "Oversee the replacement process for Fabric Interconnects (FIs).\n", "PRIVSET.Reserve licenses": "Reserve licensing slots for specific private virtual appliance (PVA).\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Reset CMOS": "AReset CMOS settings, restoring BIOS to default.\n", "PRIVSET.Reset IOMs and IFMs": "Reboot Input/Output Module (IOM) or Intelligent Fabric Module (IFM).\n", "PRIVSET.Reset VMs": "Reset a virtual machine (VM).\n", "PRIVSET.Reset memory errors": "Reset memory errors on servers.\n", "PRIVSET.Reset peer IOMs and IFMs": "Reboot peer IOM or IFM to resolve issues.\n", "PRIVSET.Reset vKVM": "Reset vKVM session, restarting the interface.\n", "PRIVSET.Restart VMs": "Restart a virtual machine (VM).\n", "PRIVSET.Return licenses": "Deregister the Intersight private virtual appliance (PVA) license after the initial setup.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Run Workflows": "As a Run Workflows user, you can execute workflows in the system.\n", "PRIVSET.Run interoperability checks": "Run an interoperability check on integrated systems.\n", "PRIVSET.SAN Administrator": "As a SAN Administrator, you can create, update, delete and view the Managed SAN switch objects.\nThe capability to view and execute workflows against the SAN switches is also granted.\n\nThis role does not include the ability to claim a target. You must have a Device Technician,\nDevice Administrator, or an Account Administrator role to claim a target.\n", "PRIVSET.SAN Connectivity policies": "Manage storage area network (SAN) settings for servers.\n", "PRIVSET.SAN Operator": "As a SAN Operator, you can view the Managed SAN switch objects. The capability to view workflows against the\nSAN switches is also granted. This role does not include the ability to claim a target.\n\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to\nclaim a target.\n", "PRIVSET.SCU links": "Manage server configuration utility (SCU) links.\n", "PRIVSET.SD Card policies": "Configure the Cisco FlexFlash and FlexUtil Secure Digital (SD) cards for Cisco UCS servers. This policy specifies details of virtual drives on the SD cards and allows configuration in different modes such as Operating System Only, Utility Only, or Operating System + Utility modes.\n", "PRIVSET.SD card operations": "Manage SD card operations like mounting and formatting.\n", "PRIVSET.SMTP policies": "Set SMTP client preferences for outgoing communications on managed devices.\n", "PRIVSET.SNMP policies": "Manage SNMP settings for sending alerts and traps from managed devices.\n", "PRIVSET.SSH policies": "Manage access control and settings for Secure Shell (SSH) connections, allowing secure remote management.\n", "PRIVSET.SSL Certificates": "As a user with access to SSL Certificates, you can view and manage the SSL certificates used for secure communications within the system.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Save and clone explorations": "Save or clone an existing exploration.\n", "PRIVSET.Scrub policies": "As a Scrub Policy user, you can create, edit, delete, and manage virtual media policies, allowing you to configure and control remote media access for servers.\n", "PRIVSET.Security and privacy": "Configure data collection and connection to Intersight.\n", "PRIVSET.Serial Over LAN policies": "Manage remote access to the management console through the server's management interface, facilitating troubleshooting and server management without a direct connection.\n", "PRIVSET.Server Administrator": "As a Server Administrator, you can view and manage UCS Servers and Fabric Interconnects,\nview all the server and Fabric Interconnect dashboard widgets, perform server actions,\nview server details, launch management interfaces and the CLI, create and deploy server\npolicies and profiles, and manage API keys. This role does not include the ability to claim a device.\nYou must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Server Profiles": "A set of privileges that allows to manage server policies and server profiles.\nServer Policy Management privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges\nrelated to server policy management.\n", "PRIVSET.Server delete virtual drives": "Remove virtual drives, managing storage volumes.\n", "PRIVSET.Server enable and disable vHBAs": "Enable or disable vHBAs to control storage operations.\n", "PRIVSET.Server enable and disable vNICs": "Enable or disable vNICs to manage network participation.\n", "PRIVSET.Server hard reset": "Initiate a hard reset on servers, restarting hardware without a graceful shutdown.\n", "PRIVSET.Server power cycle": "Perform a power cycle on servers, rebooting hardware.\n", "PRIVSET.Server power off": "Safely power off servers, terminating operations.\n", "PRIVSET.Server power on": "Initiate the power-on sequence for server activation.\n", "PRIVSET.Server reset vHBAs": "Reset vHBAs to resolve issues or refresh state.\n", "PRIVSET.Server reset vNICs": "Reset vNICs to resolve issues or refresh state.\n", "PRIVSET.Server secure erase drives": "Perform a secure erase on drives, permanently removing data.\n", "PRIVSET.Server set drive states": "Change drive states to control availability.\n", "PRIVSET.Server shutdown OS": "Initiate a graceful shutdown, ensuring services close properly before powering down.\n", "PRIVSET.Servers": "A set of privileges that allows the access to detailed server information and to perform server related actions.\nServers privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges\nrelated to servers.\n", "PRIVSET.Service Designer": "As a Service Designer, you can create tasks, workflows, custom datatypes, resource selection criteria, and use\nthese building blocks to create service items. The service items are used to create resources with attributes\nin Intersight and associate with deploy, maintenance, and decommission actions on the resource.\n", "PRIVSET.Service Operator": "As a Service Operator, you can view and update the catalog items, service items, and workflows.\nYou can deploy these resources and validate the catalog or service items.\n", "PRIVSET.Sessions": "Manage and view active sessions.\n", "PRIVSET.Set Fabric Interconnect user labels": "Assign and manage user labels for Fabric Interconnect.\n", "PRIVSET.Set IMC certificates": "Assign and manage integrated management controller (IMC) certificates on servers.\n", "PRIVSET.Set KMIP client certificates": "Assign and manage key management interoperability protocol (KMIP) in Intersight for cryptographic keys and client certificates on servers.\n", "PRIVSET.Set and unset IP pool tags": "Assign or unassign tags to IP address pools for categorization.\n", "PRIVSET.Set and unset chassis profile tags": "As a Set or Unset chassis profile Tag user, you can apply tags to chassis profiles to categorize and manage them more effectively within your infrastructure.\n", "PRIVSET.Set and unset domain profile tags": "As a Set or Unset Domain Profile Tag user, you can assign, update or remove tags on a chassis profile.\n", "PRIVSET.Set and unset server profile tags": "As a Set Server or Unset Profile Tag user, you can assign, remove and manage tags for server profiles.\nThis includes creating, updating, and ensuring tags are correctly applied for improved categorization and identification.\n", "PRIVSET.Set chassis profile user labels": "Assign and manage user labels for chassis profiles.\n", "PRIVSET.Set chassis user labels": "Assign and manage user labels for chassis.\n", "PRIVSET.Set domain profile user labels": "Assign and manage user labels for domain profiles.\n", "PRIVSET.Set or Unset Fabric Interconnect Tag": "As a Set or Unset Fabric Interconnect Tag user, you can assign, update or remove tags.\n", "PRIVSET.Set or Unset IQN Pool Tags": "As a Set or Unset IQN Pool Tags user, you can assign tags to IQN pools or you can remove tags from IQN pools.\n", "PRIVSET.Set or Unset MAC Pool Tags": "As a Set or Unset MAC Pool Tags user, you can assign tags to MAC address pools or you can remove tags from MAC address pools.\n", "PRIVSET.Set or Unset Resource Pool Tags": "As a Set or Unset Resource Pool Tags user, you can assign tags to resource pools or you can remove tags from resource pools.\n", "PRIVSET.Set or Unset Server Tag": "As a Set or unset Server Tag user, you can assign, remove and manage tags for servers.\n", "PRIVSET.Set or Unset UUID Pool Tags": "As a Set or Unset UUID Pool Tags user, you can assign tags to UUID pools or you can remove tags from UUID pools.\n", "PRIVSET.Set or Unset chassis Tag": "As a Set or Unset chassis Tag user, you can assign update or remove tags on a chassis for better identification and management.\n", "PRIVSET.Set or unset WWNN or WWPN pool tags": "Set or remove unique IDs for Fibre Channel resources on a server.\n", "PRIVSET.Set server asset tags": "Assign and manage asset tags for servers.\n", "PRIVSET.Set server license tiers": "Assign and manage Intersight license tiers for servers.\n", "PRIVSET.Set server profile user labels": "Assign and manage user labels for server profiles.\n", "PRIVSET.Set server user labels": "Assign and manage user labels for servers.\n", "PRIVSET.Single sign-on": "Manage single sign-on (SSO) integrations and authentication methods for seamless access to multiple applications.\n", "PRIVSET.Soft stop VMs": "Perform a soft stop on a virtual machine (VM).\n", "PRIVSET.Software repository": "Manage the software repository.\n", "PRIVSET.Start and resume VMs": "Start or resume a virtual machine (VM).\n", "PRIVSET.Stop VMs": "Stop a virtual machine (VM).\n", "PRIVSET.Storage Administrator": "As a Storage Administrator, a user can view and manage Storage devices, view and execute\nworkflows and view all the storage dashboard widgets.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Storage Arrays": "A set of privileges that allows the access to detailed storage array information and to perform storage array related actions.\nStorage Arrays privilege set is the top level privilege set of other privilege set(s) which are mapped to privileges\nrelated to storage arrays.\n", "PRIVSET.Storage policies": "Manage storage resources (such as local drives, RAID configurations, and external storage).\n", "PRIVSET.Support": "Download server event logs, rediscover servers and chassis, control server and chassis locator LEDs, and start server alarm suppression in Intersight Infrastructure Services.\n", "PRIVSET.Support Services": "As a Support Services user, you can view the dashboard and table views of managed devices, change your user preferences, collect tech support bundles, and generate API keys. In this role, you cannot claim targets, add or remove users, configure Identity Providers, or perform server actions.\n", "PRIVSET.Support chassis": "Perform chassis support functions such as diagnostics, troubleshooting, and managing chassis health.\n", "PRIVSET.Support domains": "Perform domain support functions such as diagnostics, troubleshooting, and managing domain health.\n", "PRIVSET.Support servers": "Perform server support functions such as diagnostics, troubleshooting, and managing server health.\n", "PRIVSET.Suspend VMs": "Suspend a virtual machine (VM).\n", "PRIVSET.Sustainability Metrics Viewer": "As a Sustainability Metrics Viewer user, you have read access to the Energy Management Capability (EMC) features and the ability\nregister an OAuth2 application for programmatic access to the APIs.\n", "PRIVSET.Switch Control policies": "Configure changes on the Fabric Interconnects for transitioning between in-host and switching modes, enabling VLAN Port optimization and managing system VLAN settings.\n", "PRIVSET.Switch Profiles": "A set of privileges that allows to manage Switch Profiles and Network configuration policies.\n", "PRIVSET.Switch to Self Signed CSR": "As a user with the ability to switch to self-signed Certificate Signing Requests (CSR), you can change the configuration to use self-signed certificates for secure communications.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Sync Smart Licensing": "Manage and track Cisco licenses directly from the Intersight platform to ensure seamless monitoring of compliance and usage.\n", "PRIVSET.Syslog policies": "Manage local and remote logging capabilities.\n", "PRIVSET.System Administration": "System related settings of Intersight Infrastructure Services. (Selecting any privilege under this hierarchy will change the scope of privilege set to 'All' and can not be used for 'Organization' scope in Role creation.)\n", "PRIVSET.System QoS policies": "Configure network traffic prioritization by assigning system classes for individual vNICs.\n", "PRIVSET.Tag Management": "Users can view and manage tag definitions. This role provides tag management privileges to an user.\n", "PRIVSET.Tech support bundles": "Manage and configure tech support bundles.\n", "PRIVSET.Telemetry": "A set of privileges that allows to access to telemetry data.\nTelemetry privilege set is the top level privilege set of other\nprivilege set(s) which are mapped to privileges related to Telemetry.\nView Telemetry allows [POST of a Druid query](http://druid.io/docs/latest/querying/querying).\nManage Telemetry allows [READ of broker information](http://druid.io/docs/latest/operations/api-reference.html#broker).\n", "PRIVSET.Terminate VMs": "Terminate a virtual machine (VM).\n", "PRIVSET.Terminate sessions": "Terminate active vKVM, Tunneled vKVM, and VMRC console sessions launched from Intersight.\n", "PRIVSET.Thermal policies": "Set the fan control mode.\n", "PRIVSET.Traffic mirroring SPAN session": "As a Manage Traffic Mirroring Sessions user, you can set up and control traffic mirroring sessions to capture and analyze network traffic for monitoring, troubleshooting, or performance analysis.\n", "PRIVSET.Trusted certificates": "Manage trusted certificates for secure communications.\n", "PRIVSET.Turn Fabric Extender locator LED on and off": "Turn on or off the LED locator on the selected FEX.\n", "PRIVSET.Turn chassis locator LEDs on and off": "Toggle the locator LED on or off for the chassis to visually locate it within a rack or data center for maintenance.\n", "PRIVSET.Turn server locator LEDs on and off": "Toggle the locator LED on or off to visually locate the server within a rack or data center for maintenance.\n", "PRIVSET.UCS Domain Administrator": "As a UCS Domain Administrator, you can view and manage Switch Profiles and Network Configuration Policies, view Fabric Interconnect dashboard widgets, perform actions on Switch, launch management interfaces and the CLI, create and deploy switch policies and profiles, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Unassign chassis profiles": "Remove domain profiles from servers, disconnecting settings.\n", "PRIVSET.Unassign domain profiles": "Remove domain profiles, disconnecting server settings.\n", "PRIVSET.Unassign server profiles": "Unassign the server from the profile.\n", "PRIVSET.Unclaim device connector": "Remove the association of a device connector from its current claim to allow reconfiguration or reassignment to a different system or user.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Unclaim targets": "Remove a target from the system's management or monitoring scope.\n", "PRIVSET.Unified Edge": "A set of privileges that allows to perform operations related to Unified Edge chassis.\n", "PRIVSET.Unified Edge Administrator": "As a Unified Edge Administrator, you can view and manage Switch Profiles and Network Configuration Policies, view Unified Edge dashboard widgets, perform actions on Switch, launch management interfaces and the CLI, create and deploy switch policies and profiles, and manage API keys. This role does not include the ability to claim a device. You must have a Device Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Unified Edge Profiles": "A set of privileges that allows to manage Unified Edge Profiles, Network and Chassis configuration policies.\n", "PRIVSET.Unlock and lock front panels": "Control access to the server's front panel.\n", "PRIVSET.Unlock disks": "Unlock encrypted disks to grant data access.\n", "PRIVSET.Update reserved licenses": "Reserve licenses again and generate a new authorization code in Smart Licensing Manager.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Upgrade chassis firmware": "Update the firmware of a chassis.\n", "PRIVSET.Upgrade domain firmware": "Update the firmware for a Domain.\n", "PRIVSET.Upgrade server firmware": "Disconnect the server from the network, erase all data, and update inventory records to reflect the change.\n", "PRIVSET.User Access Administrator": "As a User Access Administrator, you can add and manage Users and Groups in Intersight, view account details\nand audit logs, manage the IdPs, roles, sessions and API keys for non Account Administrator users.\nHowever, you cannot claim a device or perform any management tasks in Intersight.\nYou cannot add or manage a user with Account Administrator role.\n", "PRIVSET.VLAN policies": "Set up network segmentation by defining VLANs specific to organizations.\n", "PRIVSET.VSAN policies": "Configure Virtual Storage Area Networks (VSANs) on fabric fibre channel uplinks.\n", "PRIVSET.Verify domain names": "Perform checks and validations on domain names to ensure correctness and functionality for network addressing and resource identification.\n", "PRIVSET.View Access and Permissions": "View access control rules and permissions.\n", "PRIVSET.View Approval Requests": "View Approval Requests\n", "PRIVSET.View Audit Logs": "View audit logs.\n", "PRIVSET.View Datacenters": "View and monitor datacenters.\n", "PRIVSET.View Devices": "A set of privileges that allows read access to devices.\n", "PRIVSET.View Exports": "A set of privileges that allow users to view export operations.\n", "PRIVSET.View Fabric Interconnects": "View Fabric Interconnects.\n", "PRIVSET.View Functions": "A set of privileges that allows the users to view serverless functions.\n", "PRIVSET.View HCI Clusters": "View HyperConverged Infrastructure Clusters.\n", "PRIVSET.View HyperFlex Cluster Profiles": "View HyperFlex Cluster Profiles.\n", "PRIVSET.View HyperFlex Clusters": "View HyperFlex Clusters.\n", "PRIVSET.View Hypervisors": "A set of privileges that allow users to view hypervisor and virtual machines related inventory and dashboards.\n", "PRIVSET.View Imports": "A set of privileges that allow users to view the import operations.\n", "PRIVSET.View Language Runtimes": "A set of privileges that allows the users to view language runtimes for serverless functions.\n", "PRIVSET.View Licensing Status": "View Licensing Status\n", "PRIVSET.View Network Switches": "A set of privileges that allow the users to view the network switches.\n", "PRIVSET.View Nexus Config": "A set of privileges that allows users to view their site templates and policies.\n", "PRIVSET.View Nexus Reports": "A set of privileges that allow the users to view nexus reports.\n", "PRIVSET.View Nexus Sites": "A set of privileges that allows users to view their onboarded sites and status.\n", "PRIVSET.View Organizations": "View Organizations\n", "PRIVSET.View SAN Switches": "A set of privileges that allow the users to view the SAN switches.\n", "PRIVSET.View Server Profiles": "View server profiles.\n", "PRIVSET.View Servers": "View Servers.\n", "PRIVSET.View Storage Arrays": "A set of privileges that allow the users to view storage related inventory and dashboards.\n", "PRIVSET.View Switch Profiles": "View Switch Profiles.\n", "PRIVSET.View Telemetry": "allows [POST of a Druid query](http://druid.io/docs/latest/querying/querying).\n", "PRIVSET.View Unified Edge": "View Unified Edge.\n", "PRIVSET.View Unified Edge Profiles": "View Unified Edge Profiles.\n", "PRIVSET.View Workflow Definitions": "A set of privileges that allow the users to view the workflow, task and custom data type definitions.\n", "PRIVSET.View Workflow Executions": "A set of privileges that allow the users to view the running instances of the workflows.\n", "PRIVSET.View Workload Definitions": "A set of privileges that allow the users to view workload definitions.\n", "PRIVSET.View Workload Deployments": "A set of privileges that allow the users to view workload deployments.\n", "PRIVSET.View clusters": "View and monitor clusters.\n", "PRIVSET.View datastore clusters": "View and monitor datastore clusters.\n", "PRIVSET.View datastores": "View and monitor datastores.\n", "PRIVSET.View sessions": "View and terminate active vKVM, Tunneled vKVM, and VMRC console sessions launched from Intersight, and view session history.\n", "PRIVSET.View virtual machine templates": "Manage and configure virtual machine (VM) templates.\n", "PRIVSET.Virtual KVM policies": "Attach/detach Virtual KVM policies.\n", "PRIVSET.Virtual Media policies": "Enable the virtual media service on the endpoint, encryption of all communications and low power USB.\n", "PRIVSET.Virtual appliance licensing": "Manage the licensing for virtual appliance (VA). Learn more, Introduction to Licensing.\nNote: This is a virtual appliance only privilege.\n", "PRIVSET.Virtual machines": "Manage and configure virtual machines (VMs).\n", "PRIVSET.Virtualization Administrator": "As a Virtualization Administrator, a user can view and manage hypervisor resources, view\nand execute workflows.\n\nThis privilege does not include the ability to claim a device. You must have a\nDevice Technician, Device Administrator, or an Account Administrator role to claim a device.\n", "PRIVSET.Virtualization hosts": "Manage and configure virtualization hosts.\n", "PRIVSET.Withdraw Approvals": "Withdraw Approvals\n", "PRIVSET.Workflow Designer": "As a Workflow Designer, you can define workflow definitions and custom data types,\nview workflow definitions, task definitions and custom data types, execute workflows and\nview workflow executions.\n", "PRIVSET.Workload Administrator": "As a Workload Administrator, you can define workload definitions using Blueprints and underlying ServiceItems \nand workflow definitions. You can also define workload deployments using Workload Definitions and deploy workloads \nto target devices.\n", "PRIVSET.Workload Designer": "As a Workload Designer, you can define workload definitions using Blueprints and underlying ServiceItems \nand workflow definitions. \n", "PRIVSET.Workload Operator": "As a Workload Operator, you can define workload deployments using Workload Definitions and deploy workloads \nto target devices.\n", "PRIVSET.Workload Optimizer Administrator": "As a Workload Optimizer Administrator, you can access all Workload Optimizer features and perform \nadministrative tasks to configure Workload Optimizer.\n", "PRIVSET.Workload Optimizer Advisor": "As a Workload Optimizer Advisor, you can view workload optimization state and recommended actions,\nrun plans for workload optimization.\n", "PRIVSET.Workload Optimizer Automator": "As a Workload Optimizer Automator, you can view workload optimization state, recommended actions,\nrun plans for workload optimization, execute workload optimization actions, and deploy workloads.\n", "PRIVSET.Workload Optimizer Deployer": "As a Workload Optimizer Deployer, you can view all Workload Optimizer charts and data, deploy \nworkloads, and create policies and templates. You cannot run plans or execute any recommended actions.\n", "PRIVSET.Workload Optimizer Observer": "As a Workload Optimizer Observer, you can view workload optimization state and recommended actions.\n", "PRIVSET.iSCSI Adapter policies": "Configure settings for iSCSI traffic management, including TCP Connection Timeout, DHCP Timeout, and Retry Count for busy LUN IDs, optimizing iSCSI boot configurations.\n", "PRIVSET.iSCSI Boot policies": "Configure settings required to enable a server to boot from an iSCSI-based storage device.\n", "PRIVSET.iSCSI Static Target policies": "Define static iSCSI target configuration settings for servers that need to connect to specific storage devices over the iSCSI protocol.\n", "PRIVSET.vKVM Only": "As a vKVM-only user, you can launch vKVM and tunneled vKVM sessions to a server from Intersight. In addition you can view servers, chassis and the running workflows. In this role, you cannot perform any server actions from Intersight apart from launching vKVM.\n", "READ.aaa.AuditRecord": "Read a 'aaa.AuditRecord' resource.", "READ.aaa.RetentionConfig": "Read a 'aaa.RetentionConfig' resource.", "CREATE.aaa.RetentionPolicy": "Create a 'aaa.RetentionPolicy' resource.", "READ.aaa.RetentionPolicy": "Read a 'aaa.RetentionPolicy' resource.", "UPDATE.aaa.RetentionPolicy": "Update a 'aaa.RetentionPolicy' resource.", "READ.access.IpAddress": "Read a 'access.IpAddress' resource.", "CREATE.access.Policy": "Create a 'access.Policy' resource.", "DELETE.access.Policy": "Delete a 'access.Policy' resource.", "READ.access.Policy": "Read a 'access.Policy' resource.", "UPDATE.access.Policy": "Update a 'access.Policy' resource.", "READ.access.PolicyInventory": "Read a 'access.PolicyInventory' resource.", "CREATE.adapter.ConfigPolicy": "Create a 'adapter.ConfigPolicy' resource.", "DELETE.adapter.ConfigPolicy": "Delete a 'adapter.ConfigPolicy' resource.", "READ.adapter.ConfigPolicy": "Read a 'adapter.ConfigPolicy' resource.", "UPDATE.adapter.ConfigPolicy": "Update a 'adapter.ConfigPolicy' resource.", "READ.adapter.ExtEthInterface": "Read a 'adapter.ExtEthInterface' resource.", "READ.adapter.HostEthInterface": "Read a 'adapter.HostEthInterface' resource.", "UPDATE.adapter.HostEthInterface": "Update a 'adapter.HostEthInterface' resource.", "READ.adapter.HostFcInterface": "Read a 'adapter.HostFcInterface' resource.", "UPDATE.adapter.HostFcInterface": "Update a 'adapter.HostFcInterface' resource.", "READ.adapter.HostIscsiInterface": "Read a 'adapter.HostIscsiInterface' resource.", "READ.adapter.Unit": "Read a 'adapter.Unit' resource.", "READ.adapter.UnitExpander": "Read a 'adapter.UnitExpander' resource.", "READ.apic.AciPod": "Read a 'apic.AciPod' resource.", "READ.apic.Application": "Read a 'apic.Application' resource.", "READ.apic.ApplicationEndpointGroup": "Read a 'apic.ApplicationEndpointGroup' resource.", "READ.apic.BridgeDomain": "Read a 'apic.BridgeDomain' resource.", "READ.apic.ExternalRoutedLayerThreeDomain": "Read a 'apic.ExternalRoutedLayerThreeDomain' resource.", "READ.apic.FabricLeafNode": "Read a 'apic.FabricLeafNode' resource.", "READ.apic.FabricLeafNodeInterface": "Read a 'apic.FabricLeafNodeInterface' resource.", "READ.apic.Out": "Read a 'apic.Out' resource.", "READ.apic.Subnet": "Read a 'apic.Subnet' resource.", "READ.apic.Tenant": "Read a 'apic.Tenant' resource.", "READ.apic.VpcGroup": "Read a 'apic.VpcGroup' resource.", "READ.apic.Vrfs": "Read a 'apic.Vrfs' resource.", "READ.apiproxy.AllowList": "Read a 'apiproxy.AllowList' resource.", "READ.appliance.AppOpStatus": "Read a 'appliance.AppOpStatus' resource.", "READ.appliance.AppStatus": "Read a 'appliance.AppStatus' resource.", "READ.appliance.AutoRmaPolicy": "Read a 'appliance.AutoRmaPolicy' resource.", "CREATE.appliance.Backup": "Create a 'appliance.Backup' resource.", "DELETE.appliance.Backup": "Delete a 'appliance.Backup' resource.", "READ.appliance.Backup": "Read a 'appliance.Backup' resource.", "READ.appliance.BackupDownload": "Read a 'appliance.BackupDownload' resource.", "READ.appliance.BackupMonitor": "Read a 'appliance.BackupMonitor' resource.", "CREATE.appliance.BackupPolicy": "Create a 'appliance.BackupPolicy' resource.", "READ.appliance.BackupPolicy": "Read a 'appliance.BackupPolicy' resource.", "UPDATE.appliance.BackupPolicy": "Update a 'appliance.BackupPolicy' resource.", "READ.appliance.BackupRotateData": "Read a 'appliance.BackupRotateData' resource.", "READ.appliance.CertificateSetting": "Read a 'appliance.CertificateSetting' resource.", "UPDATE.appliance.CertificateSetting": "Update a 'appliance.CertificateSetting' resource.", "CREATE.appliance.ClusterInfo": "Create a 'appliance.ClusterInfo' resource.", "DELETE.appliance.ClusterInfo": "Delete a 'appliance.ClusterInfo' resource.", "READ.appliance.ClusterInfo": "Read a 'appliance.ClusterInfo' resource.", "UPDATE.appliance.ClusterInfo": "Update a 'appliance.ClusterInfo' resource.", "READ.appliance.ClusterInstall": "Read a 'appliance.ClusterInstall' resource.", "UPDATE.appliance.ClusterInstall": "Update a 'appliance.ClusterInstall' resource.", "CREATE.appliance.ClusterReplaceNode": "Create a 'appliance.ClusterReplaceNode' resource.", "READ.appliance.ClusterReplaceNode": "Read a 'appliance.ClusterReplaceNode' resource.", "UPDATE.appliance.ClusterReplaceNode": "Update a 'appliance.ClusterReplaceNode' resource.", "CREATE.appliance.ClusterWorkerNode": "Create a 'appliance.ClusterWorkerNode' resource.", "READ.appliance.ClusterWorkerNode": "Read a 'appliance.ClusterWorkerNode' resource.", "UPDATE.appliance.ClusterWorkerNode": "Update a 'appliance.ClusterWorkerNode' resource.", "CREATE.appliance.ClusterWorkerNodeReplace": "Create a 'appliance.ClusterWorkerNodeReplace' resource.", "CREATE.appliance.ClusterWorkerNodeReuse": "Create a 'appliance.ClusterWorkerNodeReuse' resource.", "READ.appliance.CpuUtilization": "Read a 'appliance.CpuUtilization' resource.", "CREATE.appliance.DataExportPolicy": "Create a 'appliance.DataExportPolicy' resource.", "READ.appliance.DataExportPolicy": "Read a 'appliance.DataExportPolicy' resource.", "UPDATE.appliance.DataExportPolicy": "Update a 'appliance.DataExportPolicy' resource.", "READ.appliance.DeviceCertificate": "Read a 'appliance.DeviceCertificate' resource.", "CREATE.appliance.DeviceClaim": "Create a 'appliance.DeviceClaim' resource.", "READ.appliance.DeviceClaim": "Read a 'appliance.DeviceClaim' resource.", "UPDATE.appliance.DeviceClaim": "Update a 'appliance.DeviceClaim' resource.", "READ.appliance.DeviceClusterInstall": "Read a 'appliance.DeviceClusterInstall' resource.", "READ.appliance.DeviceState": "Read a 'appliance.DeviceState' resource.", "READ.appliance.DeviceUpgradePolicy": "Read a 'appliance.DeviceUpgradePolicy' resource.", "UPDATE.appliance.DeviceUpgradePolicy": "Update a 'appliance.DeviceUpgradePolicy' resource.", "CREATE.appliance.DiagSetting": "Create a 'appliance.DiagSetting' resource.", "READ.appliance.DiagSetting": "Read a 'appliance.DiagSetting' resource.", "UPDATE.appliance.DiagSetting": "Update a 'appliance.DiagSetting' resource.", "CREATE.appliance.ExternalSyslogSetting": "Create a 'appliance.ExternalSyslogSetting' resource.", "DELETE.appliance.ExternalSyslogSetting": "Delete a 'appliance.ExternalSyslogSetting' resource.", "READ.appliance.ExternalSyslogSetting": "Read a 'appliance.ExternalSyslogSetting' resource.", "UPDATE.appliance.ExternalSyslogSetting": "Update a 'appliance.ExternalSyslogSetting' resource.", "READ.appliance.FileGateway": "Read a 'appliance.FileGateway' resource.", "READ.appliance.FileSystemOpStatus": "Read a 'appliance.FileSystemOpStatus' resource.", "READ.appliance.FileSystemOpSummary": "Read a 'appliance.FileSystemOpSummary' resource.", "READ.appliance.FileSystemStatus": "Read a 'appliance.FileSystemStatus' resource.", "READ.appliance.FileSystemTelemetry": "Read a 'appliance.FileSystemTelemetry' resource.", "CREATE.appliance.FqdnUpdate": "Create a 'appliance.FqdnUpdate' resource.", "READ.appliance.FqdnUpdate": "Read a 'appliance.FqdnUpdate' resource.", "UPDATE.appliance.FqdnUpdate": "Update a 'appliance.FqdnUpdate' resource.", "READ.appliance.GroupOpStatus": "Read a 'appliance.GroupOpStatus' resource.", "READ.appliance.GroupStatus": "Read a 'appliance.GroupStatus' resource.", "READ.appliance.ImageBundle": "Read a 'appliance.ImageBundle' resource.", "READ.appliance.MemoryUtilization": "Read a 'appliance.MemoryUtilization' resource.", "READ.appliance.MetaManifest": "Read a 'appliance.MetaManifest' resource.", "READ.appliance.MetricsConfig": "Read a 'appliance.MetricsConfig' resource.", "UPDATE.appliance.MetricsConfig": "Update a 'appliance.MetricsConfig' resource.", "READ.appliance.MetricsIngestionUtilization": "Read a 'appliance.MetricsIngestionUtilization' resource.", "READ.appliance.NetworkLinkStatus": "Read a 'appliance.NetworkLinkStatus' resource.", "READ.appliance.NodeInfo": "Read a 'appliance.NodeInfo' resource.", "READ.appliance.NodeIopsMetric": "Read a 'appliance.NodeIopsMetric' resource.", "READ.appliance.NodeOpStatus": "Read a 'appliance.NodeOpStatus' resource.", "READ.appliance.NodeStatus": "Read a 'appliance.NodeStatus' resource.", "READ.appliance.NodeTelemetry": "Read a 'appliance.NodeTelemetry' resource.", "READ.appliance.ReleaseNote": "Read a 'appliance.ReleaseNote' resource.", "CREATE.appliance.RemoteFileImport": "Create a 'appliance.RemoteFileImport' resource.", "READ.appliance.RemoteFileImport": "Read a 'appliance.RemoteFileImport' resource.", "CREATE.appliance.Restore": "Create a 'appliance.Restore' resource.", "DELETE.appliance.Restore": "Delete a 'appliance.Restore' resource.", "READ.appliance.Restore": "Read a 'appliance.Restore' resource.", "READ.appliance.SetupInfo": "Read a 'appliance.SetupInfo' resource.", "UPDATE.appliance.SetupInfo": "Update a 'appliance.SetupInfo' resource.", "READ.appliance.SystemInfo": "Read a 'appliance.SystemInfo' resource.", "READ.appliance.SystemOpStatus": "Read a 'appliance.SystemOpStatus' resource.", "READ.appliance.SystemStatus": "Read a 'appliance.SystemStatus' resource.", "DELETE.appliance.Upgrade": "Delete a 'appliance.Upgrade' resource.", "READ.appliance.Upgrade": "Read a 'appliance.Upgrade' resource.", "UPDATE.appliance.Upgrade": "Update a 'appliance.Upgrade' resource.", "READ.appliance.UpgradePolicy": "Read a 'appliance.UpgradePolicy' resource.", "UPDATE.appliance.UpgradePolicy": "Update a 'appliance.UpgradePolicy' resource.", "READ.appliance.UpgradeTracker": "Read a 'appliance.UpgradeTracker' resource.", "CREATE.asset.ClaimToken": "Create a 'asset.ClaimToken' resource.", "DELETE.asset.ClaimToken": "Delete a 'asset.ClaimToken' resource.", "READ.asset.ClaimToken": "Read a 'asset.ClaimToken' resource.", "READ.asset.ClusterMember": "Read a 'asset.ClusterMember' resource.", "READ.asset.Deployment": "Read a 'asset.Deployment' resource.", "READ.asset.DeploymentDevice": "Read a 'asset.DeploymentDevice' resource.", "CREATE.asset.DeviceClaim": "Create a 'asset.DeviceClaim' resource.", "DELETE.asset.DeviceClaim": "Delete a 'asset.DeviceClaim' resource.", "READ.asset.DeviceConfiguration": "Read a 'asset.DeviceConfiguration' resource.", "UPDATE.asset.DeviceConfiguration": "Update a 'asset.DeviceConfiguration' resource.", "READ.asset.DeviceConnectorManager": "Read a 'asset.DeviceConnectorManager' resource.", "READ.asset.DeviceContractInformation": "Read a 'asset.DeviceContractInformation' resource.", "UPDATE.asset.DeviceContractInformation": "Update a 'asset.DeviceContractInformation' resource.", "CREATE.asset.DeviceContractNotification": "Create a 'asset.DeviceContractNotification' resource.", "READ.asset.DeviceRegistration": "Read a 'asset.DeviceRegistration' resource.", "UPDATE.asset.DeviceRegistration": "Updates the resource representing the device connector. For example, this can be used to annotate the device connector resource with user-specified tags.", "CREATE.asset.GeoLocation": "Create a 'asset.GeoLocation' resource.", "DELETE.asset.GeoLocation": "Delete a 'asset.GeoLocation' resource.", "READ.asset.GeoLocation": "Read a 'asset.GeoLocation' resource.", "UPDATE.asset.GeoLocation": "Update a 'asset.GeoLocation' resource.", "CREATE.asset.PreClaim": "Create a 'asset.PreClaim' resource.", "UPDATE.asset.PreClaim": "Update a 'asset.PreClaim' resource.", "READ.asset.Subscription": "Read a 'asset.Subscription' resource.", "READ.asset.SubscriptionAccount": "Read a 'asset.SubscriptionAccount' resource.", "READ.asset.SubscriptionDeviceContractInformation": "Read a 'asset.SubscriptionDeviceContractInformation' resource.", "CREATE.asset.Target": "Create a 'asset.Target' resource.", "DELETE.asset.Target": "Delete a 'asset.Target' resource.", "READ.asset.Target": "Read a 'asset.Target' resource.", "UPDATE.asset.Target": "Update a 'asset.Target' resource.", "CREATE.auditd.Policy": "Create a 'auditd.Policy' resource.", "DELETE.auditd.Policy": "Delete a 'auditd.Policy' resource.", "READ.auditd.Policy": "Read a 'auditd.Policy' resource.", "UPDATE.auditd.Policy": "Update a 'auditd.Policy' resource.", "READ.bios.BootDevice": "Read a 'bios.BootDevice' resource.", "READ.bios.BootMode": "Read a 'bios.BootMode' resource.", "UPDATE.bios.BootMode": "Update a 'bios.BootMode' resource.", "CREATE.bios.Policy": "Create a 'bios.Policy' resource.", "DELETE.bios.Policy": "Delete a 'bios.Policy' resource.", "READ.bios.Policy": "Read a 'bios.Policy' resource.", "UPDATE.bios.Policy": "Update a 'bios.Policy' resource.", "READ.bios.SystemBootOrder": "Read a 'bios.SystemBootOrder' resource.", "READ.bios.TokenSettings": "Read a 'bios.TokenSettings' resource.", "READ.bios.Unit": "Read a 'bios.Unit' resource.", "UPDATE.bios.Unit": "Update a 'bios.Unit' resource.", "READ.bios.VfSelectMemoryRasConfiguration": "Read a 'bios.VfSelectMemoryRasConfiguration' resource.", "READ.boot.CddDevice": "Read a 'boot.CddDevice' resource.", "UPDATE.boot.CddDevice": "Update a 'boot.CddDevice' resource.", "READ.boot.DeviceBootMode": "Read a 'boot.DeviceBootMode' resource.", "UPDATE.boot.DeviceBootMode": "Update a 'boot.DeviceBootMode' resource.", "READ.boot.DeviceBootSecurity": "Read a 'boot.DeviceBootSecurity' resource.", "UPDATE.boot.DeviceBootSecurity": "Update a 'boot.DeviceBootSecurity' resource.", "READ.boot.HddDevice": "Read a 'boot.HddDevice' resource.", "UPDATE.boot.HddDevice": "Update a 'boot.HddDevice' resource.", "READ.boot.IscsiDevice": "Read a 'boot.IscsiDevice' resource.", "UPDATE.boot.IscsiDevice": "Update a 'boot.IscsiDevice' resource.", "READ.boot.NvmeDevice": "Read a 'boot.NvmeDevice' resource.", "UPDATE.boot.NvmeDevice": "Update a 'boot.NvmeDevice' resource.", "READ.boot.PchStorageDevice": "Read a 'boot.PchStorageDevice' resource.", "UPDATE.boot.PchStorageDevice": "Update a 'boot.PchStorageDevice' resource.", "CREATE.boot.PrecisionPolicy": "Create a 'boot.PrecisionPolicy' resource.", "DELETE.boot.PrecisionPolicy": "Delete a 'boot.PrecisionPolicy' resource.", "READ.boot.PrecisionPolicy": "Read a 'boot.PrecisionPolicy' resource.", "UPDATE.boot.PrecisionPolicy": "Update a 'boot.PrecisionPolicy' resource.", "READ.boot.PxeDevice": "Read a 'boot.PxeDevice' resource.", "UPDATE.boot.PxeDevice": "Update a 'boot.PxeDevice' resource.", "READ.boot.SanDevice": "Read a 'boot.SanDevice' resource.", "UPDATE.boot.SanDevice": "Update a 'boot.SanDevice' resource.", "READ.boot.SdDevice": "Read a 'boot.SdDevice' resource.", "UPDATE.boot.SdDevice": "Update a 'boot.SdDevice' resource.", "READ.boot.UefiShellDevice": "Read a 'boot.UefiShellDevice' resource.", "UPDATE.boot.UefiShellDevice": "Update a 'boot.UefiShellDevice' resource.", "READ.boot.UsbDevice": "Read a 'boot.UsbDevice' resource.", "UPDATE.boot.UsbDevice": "Update a 'boot.UsbDevice' resource.", "READ.boot.VmediaDevice": "Read a 'boot.VmediaDevice' resource.", "UPDATE.boot.VmediaDevice": "Update a 'boot.VmediaDevice' resource.", "CREATE.bulk.Export": "Create a 'bulk.Export' resource.", "DELETE.bulk.Export": "Delete a 'bulk.Export' resource.", "READ.bulk.Export": "Read a 'bulk.Export' resource.", "UPDATE.bulk.Export": "Update a 'bulk.Export' resource.", "READ.bulk.ExportedItem": "Read a 'bulk.ExportedItem' resource.", "CREATE.bulk.MoCloner": "Create a 'bulk.MoCloner' resource.", "READ.bulk.MoCloner": "Read a 'bulk.MoCloner' resource.", "CREATE.bulk.MoDeepCloner": "Create a 'bulk.MoDeepCloner' resource.", "READ.bulk.MoDeepCloner": "Read a 'bulk.MoDeepCloner' resource.", "CREATE.bulk.MoMerger": "Create a 'bulk.MoMerger' resource.", "READ.bulk.MoMerger": "Read a 'bulk.MoMerger' resource.", "CREATE.bulk.Request": "Create a 'bulk.Request' resource.", "READ.bulk.Request": "Read a 'bulk.Request' resource.", "READ.bulk.Result": "Read a 'bulk.Result' resource.", "READ.bulk.SubRequestObj": "Read a 'bulk.SubRequestObj' resource.", "READ.capability.ActionsMetaData": "Read a 'capability.ActionsMetaData' resource.", "READ.capability.AdapterDeprecatedDef": "Read a 'capability.AdapterDeprecatedDef' resource.", "READ.capability.AdapterFirmwareRequirement": "Read a 'capability.AdapterFirmwareRequirement' resource.", "READ.capability.AdapterUnitDescriptor": "Read a 'capability.AdapterUnitDescriptor' resource.", "READ.capability.AdapterUpdateConstraintMeta": "Read a 'capability.AdapterUpdateConstraintMeta' resource.", "READ.capability.AdapterUpgradeSupportMeta": "Read a 'capability.AdapterUpgradeSupportMeta' resource.", "READ.capability.BiosTokens": "Read a 'capability.BiosTokens' resource.", "READ.capability.Catalog": "Read a 'capability.Catalog' resource.", "READ.capability.ChassisDescriptor": "Read a 'capability.ChassisDescriptor' resource.", "READ.capability.ChassisManufacturingDef": "Read a 'capability.ChassisManufacturingDef' resource.", "READ.capability.ChassisUpgradeSupportMeta": "Read a 'capability.ChassisUpgradeSupportMeta' resource.", "READ.capability.CimcFirmwareDescriptor": "Read a 'capability.CimcFirmwareDescriptor' resource.", "READ.capability.CpuEndpointDescriptor": "Read a 'capability.CpuEndpointDescriptor' resource.", "READ.capability.DimmsEndpointDescriptor": "Read a 'capability.DimmsEndpointDescriptor' resource.", "READ.capability.DomainPolicyRequirement": "Read a 'capability.DomainPolicyRequirement' resource.", "READ.capability.DrivesEndpointDescriptor": "Read a 'capability.DrivesEndpointDescriptor' resource.", "READ.capability.EquipmentPhysicalDef": "Read a 'capability.EquipmentPhysicalDef' resource.", "READ.capability.EquipmentSlotArray": "Read a 'capability.EquipmentSlotArray' resource.", "READ.capability.FanModuleDescriptor": "Read a 'capability.FanModuleDescriptor' resource.", "READ.capability.FanModuleManufacturingDef": "Read a 'capability.FanModuleManufacturingDef' resource.", "READ.capability.FexCapabilityDef": "Read a 'capability.FexCapabilityDef' resource.", "READ.capability.FexDescriptor": "Read a 'capability.FexDescriptor' resource.", "READ.capability.FexManufacturingDef": "Read a 'capability.FexManufacturingDef' resource.", "READ.capability.FexSupportMeta": "Read a 'capability.FexSupportMeta' resource.", "READ.capability.GpuEndpointDescriptor": "Read a 'capability.GpuEndpointDescriptor' resource.", "READ.capability.HsuIsoFileSupportMeta": "Read a 'capability.HsuIsoFileSupportMeta' resource.", "READ.capability.IoCardCapabilityDef": "Read a 'capability.IoCardCapabilityDef' resource.", "READ.capability.IoCardDescriptor": "Read a 'capability.IoCardDescriptor' resource.", "READ.capability.IoCardManufacturingDef": "Read a 'capability.IoCardManufacturingDef' resource.", "READ.capability.IomUpgradeSupportMeta": "Read a 'capability.IomUpgradeSupportMeta' resource.", "READ.capability.NetworkEquipmentPowerDef": "Read a 'capability.NetworkEquipmentPowerDef' resource.", "READ.capability.PolicyConstants": "Read a 'capability.PolicyConstants' resource.", "READ.capability.PortGroupAggregationDef": "Read a 'capability.PortGroupAggregationDef' resource.", "READ.capability.ProcessorUnitUpdateConstraintMeta": "Read a 'capability.ProcessorUnitUpdateConstraintMeta' resource.", "READ.capability.PsuDescriptor": "Read a 'capability.PsuDescriptor' resource.", "READ.capability.PsuManufacturingDef": "Read a 'capability.PsuManufacturingDef' resource.", "READ.capability.ServerActionsMeta": "Read a 'capability.ServerActionsMeta' resource.", "READ.capability.ServerDescriptor": "Read a 'capability.ServerDescriptor' resource.", "READ.capability.ServerModelsCapabilityDef": "Read a 'capability.ServerModelsCapabilityDef' resource.", "READ.capability.ServerPcieConnectivityCatalog": "Read a 'capability.ServerPcieConnectivityCatalog' resource.", "READ.capability.ServerSchemaDescriptor": "Read a 'capability.ServerSchemaDescriptor' resource.", "READ.capability.ServerTopologyMap": "Read a 'capability.ServerTopologyMap' resource.", "READ.capability.ServerUpgradeSupportMeta": "Read a 'capability.ServerUpgradeSupportMeta' resource.", "READ.capability.SiocModuleCapabilityDef": "Read a 'capability.SiocModuleCapabilityDef' resource.", "READ.capability.SiocModuleDescriptor": "Read a 'capability.SiocModuleDescriptor' resource.", "READ.capability.SiocModuleManufacturingDef": "Read a 'capability.SiocModuleManufacturingDef' resource.", "READ.capability.StandardRedfishSupportMeta": "Read a 'capability.StandardRedfishSupportMeta' resource.", "READ.capability.StorageControllerUpdateConstraintMeta": "Read a 'capability.StorageControllerUpdateConstraintMeta' resource.", "READ.capability.StorageControllersMetaData": "Read a 'capability.StorageControllersMetaData' resource.", "READ.capability.SwitchCapability": "Read a 'capability.SwitchCapability' resource.", "READ.capability.SwitchDescriptor": "Read a 'capability.SwitchDescriptor' resource.", "READ.capability.SwitchEquipmentInfo": "Read a 'capability.SwitchEquipmentInfo' resource.", "READ.capability.SwitchManufacturingDef": "Read a 'capability.SwitchManufacturingDef' resource.", "READ.capability.SwitchUpgradeSupportMeta": "Read a 'capability.SwitchUpgradeSupportMeta' resource.", "READ.capability.TemplateCatalog": "Read a 'capability.TemplateCatalog' resource.", "READ.capability.TimeZoneMetaData": "Read a 'capability.TimeZoneMetaData' resource.", "READ.capability.UpdateOrderMeta": "Read a 'capability.UpdateOrderMeta' resource.", "READ.capability.VicDescriptor": "Read a 'capability.VicDescriptor' resource.", "READ.catalystsdwan.ConfigGroup": "Read a 'catalystsdwan.ConfigGroup' resource.", "READ.catalystsdwan.Interface": "Read a 'catalystsdwan.Interface' resource.", "READ.catalystsdwan.PhysicalPort": "Read a 'catalystsdwan.PhysicalPort' resource.", "READ.catalystsdwan.PolicyGroup": "Read a 'catalystsdwan.PolicyGroup' resource.", "READ.catalystsdwan.PortChannel": "Read a 'catalystsdwan.PortChannel' resource.", "READ.catalystsdwan.VedgeDevice": "Read a 'catalystsdwan.VedgeDevice' resource.", "READ.catalystsdwan.Vlan": "Read a 'catalystsdwan.Vlan' resource.", "READ.catalystsdwan.WanEdgeDevice": "Read a 'catalystsdwan.WanEdgeDevice' resource.", "CREATE.certificatemanagement.Policy": "Create a 'certificatemanagement.Policy' resource.", "DELETE.certificatemanagement.Policy": "Delete a 'certificatemanagement.Policy' resource.", "READ.certificatemanagement.Policy": "Read a 'certificatemanagement.Policy' resource.", "UPDATE.certificatemanagement.Policy": "Update a 'certificatemanagement.Policy' resource.", "READ.certificatemanagement.PolicyInventory": "Read a 'certificatemanagement.PolicyInventory' resource.", "READ.chassis.ConfigChangeDetail": "Read a 'chassis.ConfigChangeDetail' resource.", "CREATE.chassis.ConfigImport": "Create a 'chassis.ConfigImport' resource.", "READ.chassis.ConfigImport": "Read a 'chassis.ConfigImport' resource.", "READ.chassis.ConfigResult": "Read a 'chassis.ConfigResult' resource.", "READ.chassis.ConfigResultEntry": "Read a 'chassis.ConfigResultEntry' resource.", "READ.chassis.IomProfile": "Read a 'chassis.IomProfile' resource.", "CREATE.chassis.Profile": "Create a 'chassis.Profile' resource.", "DELETE.chassis.Profile": "Delete a 'chassis.Profile' resource.", "READ.chassis.Profile": "Read a 'chassis.Profile' resource.", "UPDATE.chassis.Profile": "Update a 'chassis.Profile' resource.", "CREATE.chassis.ProfileTemplate": "Create a 'chassis.ProfileTemplate' resource.", "DELETE.chassis.ProfileTemplate": "Delete a 'chassis.ProfileTemplate' resource.", "READ.chassis.ProfileTemplate": "Read a 'chassis.ProfileTemplate' resource.", "UPDATE.chassis.ProfileTemplate": "Update a 'chassis.ProfileTemplate' resource.", "CREATE.cli.CliPolicy": "Create a 'cli.CliPolicy' resource.", "DELETE.cli.CliPolicy": "Delete a 'cli.CliPolicy' resource.", "READ.cli.CliPolicy": "Read a 'cli.CliPolicy' resource.", "UPDATE.cli.CliPolicy": "Update a 'cli.CliPolicy' resource.", "CREATE.cloud.CollectInventory": "Create a 'cloud.CollectInventory' resource.", "READ.cloud.TfcAgentpool": "Read a 'cloud.TfcAgentpool' resource.", "READ.cloud.TfcOrganization": "Read a 'cloud.TfcOrganization' resource.", "READ.cloud.TfcWorkspace": "Read a 'cloud.TfcWorkspace' resource.", "CREATE.comm.HttpProxyPolicy": "Create a 'comm.HttpProxyPolicy' resource.", "DELETE.comm.HttpProxyPolicy": "Delete a 'comm.HttpProxyPolicy' resource.", "READ.comm.HttpProxyPolicy": "Read a 'comm.HttpProxyPolicy' resource.", "UPDATE.comm.HttpProxyPolicy": "Update a 'comm.HttpProxyPolicy' resource.", "CREATE.comm.TagDefinition": "Create a 'comm.TagDefinition' resource.", "DELETE.comm.TagDefinition": "Delete a 'comm.TagDefinition' resource.", "READ.comm.TagDefinition": "Read a 'comm.TagDefinition' resource.", "UPDATE.comm.TagDefinition": "Update a 'comm.TagDefinition' resource.", "READ.compute.Blade": "Read a 'compute.Blade' resource.", "UPDATE.compute.Blade": "Update a 'compute.Blade' resource.", "READ.compute.BladeIdentity": "Read a 'compute.BladeIdentity' resource.", "UPDATE.compute.BladeIdentity": "Update a 'compute.BladeIdentity' resource.", "READ.compute.Board": "Read a 'compute.Board' resource.", "UPDATE.compute.Board": "Update a 'compute.Board' resource.", "READ.compute.DownloadStatus": "Read a 'compute.DownloadStatus' resource.", "CREATE.compute.HostUtilityOperation": "Create a 'compute.HostUtilityOperation' resource.", "READ.compute.HostUtilityOperation": "Read a 'compute.HostUtilityOperation' resource.", "READ.compute.Mapping": "Read a 'compute.Mapping' resource.", "UPDATE.compute.Mapping": "Update a 'compute.Mapping' resource.", "CREATE.compute.PcieConnectivityPolicy": "Create a 'compute.PcieConnectivityPolicy' resource.", "DELETE.compute.PcieConnectivityPolicy": "Delete a 'compute.PcieConnectivityPolicy' resource.", "READ.compute.PcieConnectivityPolicy": "Read a 'compute.PcieConnectivityPolicy' resource.", "UPDATE.compute.PcieConnectivityPolicy": "Update a 'compute.PcieConnectivityPolicy' resource.", "READ.compute.PcieConnectivityPolicyInventory": "Read a 'compute.PcieConnectivityPolicyInventory' resource.", "READ.compute.Personality": "Read a 'compute.Personality' resource.", "UPDATE.compute.Personality": "Update a 'compute.Personality' resource.", "READ.compute.PhysicalSummary": "Read a 'compute.PhysicalSummary' resource.", "DELETE.compute.RackUnit": "Delete a 'compute.RackUnit' resource.", "READ.compute.RackUnit": "Read a 'compute.RackUnit' resource.", "UPDATE.compute.RackUnit": "Update a 'compute.RackUnit' resource.", "DELETE.compute.RackUnitIdentity": "Delete a 'compute.RackUnitIdentity' resource.", "READ.compute.RackUnitIdentity": "Read a 'compute.RackUnitIdentity' resource.", "UPDATE.compute.RackUnitIdentity": "Update a 'compute.RackUnitIdentity' resource.", "CREATE.compute.ScrubPolicy": "Create a 'compute.ScrubPolicy' resource.", "DELETE.compute.ScrubPolicy": "Delete a 'compute.ScrubPolicy' resource.", "READ.compute.ScrubPolicy": "Read a 'compute.ScrubPolicy' resource.", "UPDATE.compute.ScrubPolicy": "Update a 'compute.ScrubPolicy' resource.", "READ.compute.ServerIdPool": "Read a 'compute.ServerIdPool' resource.", "READ.compute.ServerPowerParameters": "Read a 'compute.ServerPowerParameters' resource.", "DELETE.compute.ServerPowerPolicy": "Delete a 'compute.ServerPowerPolicy' resource.", "READ.compute.ServerPowerPolicy": "Read a 'compute.ServerPowerPolicy' resource.", "UPDATE.compute.ServerPowerPolicy": "Update a 'compute.ServerPowerPolicy' resource.", "READ.compute.ServerSetting": "Read a 'compute.ServerSetting' resource.", "UPDATE.compute.ServerSetting": "Update a 'compute.ServerSetting' resource.", "READ.compute.Vmedia": "Read a 'compute.Vmedia' resource.", "READ.cond.Alarm": "Read a 'cond.Alarm' resource.", "UPDATE.cond.Alarm": "Update a 'cond.Alarm' resource.", "READ.cond.AlarmAggregation": "Read a 'cond.AlarmAggregation' resource.", "READ.cond.AlarmClassification": "Read a 'cond.AlarmClassification' resource.", "READ.cond.AlarmDefinition": "Read a 'cond.AlarmDefinition' resource.", "CREATE.cond.AlarmRule": "Create a 'cond.AlarmRule' resource.", "DELETE.cond.AlarmRule": "Delete a 'cond.AlarmRule' resource.", "READ.cond.AlarmRule": "Read a 'cond.AlarmRule' resource.", "UPDATE.cond.AlarmRule": "Update a 'cond.AlarmRule' resource.", "CREATE.cond.AlarmSuppression": "Create a 'cond.AlarmSuppression' resource.", "DELETE.cond.AlarmSuppression": "Delete a 'cond.AlarmSuppression' resource.", "READ.cond.AlarmSuppression": "Read a 'cond.AlarmSuppression' resource.", "UPDATE.cond.AlarmSuppression": "Update a 'cond.AlarmSuppression' resource.", "CREATE.cond.AlarmSuppressionDryRun": "Create a 'cond.AlarmSuppressionDryRun' resource.", "CREATE.cond.CustomHclBaseline": "Create a 'cond.CustomHclBaseline' resource.", "DELETE.cond.CustomHclBaseline": "Delete a 'cond.CustomHclBaseline' resource.", "READ.cond.CustomHclBaseline": "Read a 'cond.CustomHclBaseline' resource.", "UPDATE.cond.CustomHclBaseline": "Update a 'cond.CustomHclBaseline' resource.", "CREATE.cond.CustomHclStatus": "Create a 'cond.CustomHclStatus' resource.", "READ.cond.CustomHclStatus": "Read a 'cond.CustomHclStatus' resource.", "READ.cond.HclStatus": "Read a 'cond.HclStatus' resource.", "READ.cond.HclStatusDetail": "Read a 'cond.HclStatusDetail' resource.", "CREATE.cond.HclStatusJob": "Create a 'cond.HclStatusJob' resource.", "READ.cond.HclStatusJob": "Read a 'cond.HclStatusJob' resource.", "CREATE.cond.ThresholdDefinition": "Create a 'cond.ThresholdDefinition' resource.", "DELETE.cond.ThresholdDefinition": "Delete a 'cond.ThresholdDefinition' resource.", "READ.cond.ThresholdDefinition": "Read a 'cond.ThresholdDefinition' resource.", "UPDATE.cond.ThresholdDefinition": "Update a 'cond.ThresholdDefinition' resource.", "CREATE.connectorpack.ConnectorPackUpgrade": "Create a 'connectorpack.ConnectorPackUpgrade' resource.", "DELETE.connectorpack.ConnectorPackUpgrade": "Delete a 'connectorpack.ConnectorPackUpgrade' resource.", "READ.connectorpack.ConnectorPackUpgrade": "Read a 'connectorpack.ConnectorPackUpgrade' resource.", "READ.connectorpack.UpgradeImpact": "Read a 'connectorpack.UpgradeImpact' resource.", "READ.console.ConsoleConfig": "Read a 'console.ConsoleConfig' resource.", "READ.convergedinfra.AdapterComplianceDetails": "Read a 'convergedinfra.AdapterComplianceDetails' resource.", "READ.convergedinfra.Pod": "Read a 'convergedinfra.Pod' resource.", "UPDATE.convergedinfra.Pod": "Update a 'convergedinfra.Pod' resource.", "READ.convergedinfra.PodComplianceInfo": "Read a 'convergedinfra.PodComplianceInfo' resource.", "READ.convergedinfra.ServerComplianceDetails": "Read a 'convergedinfra.ServerComplianceDetails' resource.", "READ.convergedinfra.StorageComplianceDetails": "Read a 'convergedinfra.StorageComplianceDetails' resource.", "READ.convergedinfra.SwitchComplianceDetails": "Read a 'convergedinfra.SwitchComplianceDetails' resource.", "DELETE.coremanagement.CoreFile": "Delete a 'coremanagement.CoreFile' resource.", "READ.coremanagement.CoreFile": "Read a 'coremanagement.CoreFile' resource.", "UPDATE.coremanagement.CoreFile": "Update a 'coremanagement.CoreFile' resource.", "READ.coremanagement.Download": "Read a 'coremanagement.Download' resource.", "CREATE.crd.CustomResource": "Create a 'crd.CustomResource' resource.", "DELETE.crd.CustomResource": "Delete a 'crd.CustomResource' resource.", "READ.crd.CustomResource": "Read a 'crd.CustomResource' resource.", "UPDATE.crd.CustomResource": "Update a 'crd.CustomResource' resource.", "CREATE.deviceconnector.Policy": "Create a 'deviceconnector.Policy' resource.", "DELETE.deviceconnector.Policy": "Delete a 'deviceconnector.Policy' resource.", "READ.deviceconnector.Policy": "Read a 'deviceconnector.Policy' resource.", "UPDATE.deviceconnector.Policy": "Update a 'deviceconnector.Policy' resource.", "READ.dnac.Device": "Read a 'dnac.Device' resource.", "READ.dnac.DeviceInterface": "Read a 'dnac.DeviceInterface' resource.", "READ.dnac.ExternalBorderNode": "Read a 'dnac.ExternalBorderNode' resource.", "READ.dnac.ExternalBorderNodeInterface": "Read a 'dnac.ExternalBorderNodeInterface' resource.", "READ.dnac.FabricSite": "Read a 'dnac.FabricSite' resource.", "READ.dnac.Site": "Read a 'dnac.Site' resource.", "READ.dnac.SiteIpPool": "Read a 'dnac.SiteIpPool' resource.", "READ.dnac.Template": "Read a 'dnac.Template' resource.", "READ.dnac.Transit": "Read a 'dnac.Transit' resource.", "READ.dnac.VirtualNetworkFabricSite": "Read a 'dnac.VirtualNetworkFabricSite' resource.", "CREATE.energy.DailyMetrics": "Create a 'energy.DailyMetrics' resource.", "CREATE.energy.Metrics": "Create a 'energy.Metrics' resource.", "READ.equipment.Chassis": "Read a 'equipment.Chassis' resource.", "UPDATE.equipment.Chassis": "Update a 'equipment.Chassis' resource.", "READ.equipment.ChassisController": "Read a 'equipment.ChassisController' resource.", "UPDATE.equipment.ChassisController": "Update a 'equipment.ChassisController' resource.", "READ.equipment.ChassisIdPool": "Read a 'equipment.ChassisIdPool' resource.", "READ.equipment.ChassisIdentity": "Read a 'equipment.ChassisIdentity' resource.", "UPDATE.equipment.ChassisIdentity": "Update a 'equipment.ChassisIdentity' resource.", "READ.equipment.ChassisOperation": "Read a 'equipment.ChassisOperation' resource.", "UPDATE.equipment.ChassisOperation": "Update a 'equipment.ChassisOperation' resource.", "READ.equipment.DeviceSummary": "Read a 'equipment.DeviceSummary' resource.", "READ.equipment.EnclosureElement": "Read a 'equipment.EnclosureElement' resource.", "UPDATE.equipment.EnclosureElement": "Update a 'equipment.EnclosureElement' resource.", "READ.equipment.EndPointLog": "Read a 'equipment.EndPointLog' resource.", "READ.equipment.ExpanderModule": "Read a 'equipment.ExpanderModule' resource.", "UPDATE.equipment.ExpanderModule": "Update a 'equipment.ExpanderModule' resource.", "READ.equipment.ExpanderModuleIdentity": "Read a 'equipment.ExpanderModuleIdentity' resource.", "UPDATE.equipment.ExpanderModuleIdentity": "Update a 'equipment.ExpanderModuleIdentity' resource.", "READ.equipment.ExpanderModuleOperation": "Read a 'equipment.ExpanderModuleOperation' resource.", "UPDATE.equipment.ExpanderModuleOperation": "Update a 'equipment.ExpanderModuleOperation' resource.", "READ.equipment.Fan": "Read a 'equipment.Fan' resource.", "UPDATE.equipment.Fan": "Update a 'equipment.Fan' resource.", "READ.equipment.FanControl": "Read a 'equipment.FanControl' resource.", "UPDATE.equipment.FanControl": "Update a 'equipment.FanControl' resource.", "READ.equipment.FanModule": "Read a 'equipment.FanModule' resource.", "UPDATE.equipment.FanModule": "Update a 'equipment.FanModule' resource.", "READ.equipment.Fex": "Read a 'equipment.Fex' resource.", "UPDATE.equipment.Fex": "Update a 'equipment.Fex' resource.", "READ.equipment.FexIdentity": "Read a 'equipment.FexIdentity' resource.", "UPDATE.equipment.FexIdentity": "Update a 'equipment.FexIdentity' resource.", "READ.equipment.FexOperation": "Read a 'equipment.FexOperation' resource.", "UPDATE.equipment.FexOperation": "Update a 'equipment.FexOperation' resource.", "READ.equipment.Fru": "Read a 'equipment.Fru' resource.", "UPDATE.equipment.Fru": "Update a 'equipment.Fru' resource.", "READ.equipment.HybridDriveSlot": "Read a 'equipment.HybridDriveSlot' resource.", "READ.equipment.Interconnect": "Read a 'equipment.Interconnect' resource.", "READ.equipment.IoCard": "Read a 'equipment.IoCard' resource.", "UPDATE.equipment.IoCard": "Update a 'equipment.IoCard' resource.", "READ.equipment.IoCardOperation": "Read a 'equipment.IoCardOperation' resource.", "UPDATE.equipment.IoCardOperation": "Update a 'equipment.IoCardOperation' resource.", "READ.equipment.IoExpander": "Read a 'equipment.IoExpander' resource.", "UPDATE.equipment.IoExpander": "Update a 'equipment.IoExpander' resource.", "READ.equipment.LocatorLed": "Read a 'equipment.LocatorLed' resource.", "UPDATE.equipment.LocatorLed": "Update a 'equipment.LocatorLed' resource.", "READ.equipment.LogDownload": "Read a 'equipment.LogDownload' resource.", "READ.equipment.Psu": "Read a 'equipment.Psu' resource.", "UPDATE.equipment.Psu": "Update a 'equipment.Psu' resource.", "READ.equipment.PsuControl": "Read a 'equipment.PsuControl' resource.", "UPDATE.equipment.PsuControl": "Update a 'equipment.PsuControl' resource.", "READ.equipment.RackEnclosure": "Read a 'equipment.RackEnclosure' resource.", "UPDATE.equipment.RackEnclosure": "Update a 'equipment.RackEnclosure' resource.", "READ.equipment.RackEnclosureSlot": "Read a 'equipment.RackEnclosureSlot' resource.", "UPDATE.equipment.RackEnclosureSlot": "Update a 'equipment.RackEnclosureSlot' resource.", "READ.equipment.Riser": "Read a 'equipment.Riser' resource.", "READ.equipment.Sensor": "Read a 'equipment.Sensor' resource.", "READ.equipment.SharedAdapterUnit": "Read a 'equipment.SharedAdapterUnit' resource.", "READ.equipment.SharedGraphicsCard": "Read a 'equipment.SharedGraphicsCard' resource.", "READ.equipment.SharedIoModule": "Read a 'equipment.SharedIoModule' resource.", "UPDATE.equipment.SharedIoModule": "Update a 'equipment.SharedIoModule' resource.", "READ.equipment.SwitchCard": "Read a 'equipment.SwitchCard' resource.", "UPDATE.equipment.SwitchCard": "Update a 'equipment.SwitchCard' resource.", "READ.equipment.SwitchOperation": "Read a 'equipment.SwitchOperation' resource.", "UPDATE.equipment.SwitchOperation": "Update a 'equipment.SwitchOperation' resource.", "READ.equipment.SystemIoController": "Read a 'equipment.SystemIoController' resource.", "UPDATE.equipment.SystemIoController": "Update a 'equipment.SystemIoController' resource.", "READ.equipment.Tpm": "Read a 'equipment.Tpm' resource.", "UPDATE.equipment.Tpm": "Update a 'equipment.Tpm' resource.", "READ.equipment.Transceiver": "Read a 'equipment.Transceiver' resource.", "UPDATE.equipment.Transceiver": "Update a 'equipment.Transceiver' resource.", "READ.ether.HostPort": "Read a 'ether.HostPort' resource.", "UPDATE.ether.HostPort": "Update a 'ether.HostPort' resource.", "READ.ether.InterSwitchPort": "Read a 'ether.InterSwitchPort' resource.", "READ.ether.LanPort": "Read a 'ether.LanPort' resource.", "READ.ether.NetworkPort": "Read a 'ether.NetworkPort' resource.", "UPDATE.ether.NetworkPort": "Update a 'ether.NetworkPort' resource.", "READ.ether.PhysicalPort": "Read a 'ether.PhysicalPort' resource.", "UPDATE.ether.PhysicalPort": "Update a 'ether.PhysicalPort' resource.", "READ.ether.PortChannel": "Read a 'ether.PortChannel' resource.", "CREATE.externalsite.Authorization": "Create a 'externalsite.Authorization' resource.", "READ.externalsite.Authorization": "Read a 'externalsite.Authorization' resource.", "UPDATE.externalsite.Authorization": "Update a 'externalsite.Authorization' resource.", "CREATE.fabric.AppliancePcRole": "Create a 'fabric.AppliancePcRole' resource.", "DELETE.fabric.AppliancePcRole": "Delete a 'fabric.AppliancePcRole' resource.", "READ.fabric.AppliancePcRole": "Read a 'fabric.AppliancePcRole' resource.", "UPDATE.fabric.AppliancePcRole": "Update a 'fabric.AppliancePcRole' resource.", "CREATE.fabric.ApplianceRole": "Create a 'fabric.ApplianceRole' resource.", "DELETE.fabric.ApplianceRole": "Delete a 'fabric.ApplianceRole' resource.", "READ.fabric.ApplianceRole": "Read a 'fabric.ApplianceRole' resource.", "UPDATE.fabric.ApplianceRole": "Update a 'fabric.ApplianceRole' resource.", "READ.fabric.ConfigChangeDetail": "Read a 'fabric.ConfigChangeDetail' resource.", "READ.fabric.ConfigResult": "Read a 'fabric.ConfigResult' resource.", "READ.fabric.ConfigResultEntry": "Read a 'fabric.ConfigResultEntry' resource.", "READ.fabric.ElementIdentity": "Read a 'fabric.ElementIdentity' resource.", "UPDATE.fabric.ElementIdentity": "Update a 'fabric.ElementIdentity' resource.", "CREATE.fabric.EstimateImpact": "Create a 'fabric.EstimateImpact' resource.", "CREATE.fabric.EthNetworkControlPolicy": "Create a 'fabric.EthNetworkControlPolicy' resource.", "DELETE.fabric.EthNetworkControlPolicy": "Delete a 'fabric.EthNetworkControlPolicy' resource.", "READ.fabric.EthNetworkControlPolicy": "Read a 'fabric.EthNetworkControlPolicy' resource.", "UPDATE.fabric.EthNetworkControlPolicy": "Update a 'fabric.EthNetworkControlPolicy' resource.", "READ.fabric.EthNetworkControlPolicyInventory": "Read a 'fabric.EthNetworkControlPolicyInventory' resource.", "CREATE.fabric.EthNetworkGroupPolicy": "Create a 'fabric.EthNetworkGroupPolicy' resource.", "DELETE.fabric.EthNetworkGroupPolicy": "Delete a 'fabric.EthNetworkGroupPolicy' resource.", "READ.fabric.EthNetworkGroupPolicy": "Read a 'fabric.EthNetworkGroupPolicy' resource.", "UPDATE.fabric.EthNetworkGroupPolicy": "Update a 'fabric.EthNetworkGroupPolicy' resource.", "READ.fabric.EthNetworkGroupPolicyInventory": "Read a 'fabric.EthNetworkGroupPolicyInventory' resource.", "CREATE.fabric.EthNetworkPolicy": "Create a 'fabric.EthNetworkPolicy' resource.", "DELETE.fabric.EthNetworkPolicy": "Delete a 'fabric.EthNetworkPolicy' resource.", "READ.fabric.EthNetworkPolicy": "Read a 'fabric.EthNetworkPolicy' resource.", "UPDATE.fabric.EthNetworkPolicy": "Update a 'fabric.EthNetworkPolicy' resource.", "CREATE.fabric.FcNetworkPolicy": "Create a 'fabric.FcNetworkPolicy' resource.", "DELETE.fabric.FcNetworkPolicy": "Delete a 'fabric.FcNetworkPolicy' resource.", "READ.fabric.FcNetworkPolicy": "Read a 'fabric.FcNetworkPolicy' resource.", "UPDATE.fabric.FcNetworkPolicy": "Update a 'fabric.FcNetworkPolicy' resource.", "CREATE.fabric.FcStorageRole": "Create a 'fabric.FcStorageRole' resource.", "DELETE.fabric.FcStorageRole": "Delete a 'fabric.FcStorageRole' resource.", "READ.fabric.FcStorageRole": "Read a 'fabric.FcStorageRole' resource.", "UPDATE.fabric.FcStorageRole": "Update a 'fabric.FcStorageRole' resource.", "CREATE.fabric.FcUplinkPcRole": "Create a 'fabric.FcUplinkPcRole' resource.", "DELETE.fabric.FcUplinkPcRole": "Delete a 'fabric.FcUplinkPcRole' resource.", "READ.fabric.FcUplinkPcRole": "Read a 'fabric.FcUplinkPcRole' resource.", "UPDATE.fabric.FcUplinkPcRole": "Update a 'fabric.FcUplinkPcRole' resource.", "CREATE.fabric.FcUplinkRole": "Create a 'fabric.FcUplinkRole' resource.", "DELETE.fabric.FcUplinkRole": "Delete a 'fabric.FcUplinkRole' resource.", "READ.fabric.FcUplinkRole": "Read a 'fabric.FcUplinkRole' resource.", "UPDATE.fabric.FcUplinkRole": "Update a 'fabric.FcUplinkRole' resource.", "CREATE.fabric.FcZonePolicy": "Create a 'fabric.FcZonePolicy' resource.", "DELETE.fabric.FcZonePolicy": "Delete a 'fabric.FcZonePolicy' resource.", "READ.fabric.FcZonePolicy": "Read a 'fabric.FcZonePolicy' resource.", "UPDATE.fabric.FcZonePolicy": "Update a 'fabric.FcZonePolicy' resource.", "CREATE.fabric.FcoeUplinkPcRole": "Create a 'fabric.FcoeUplinkPcRole' resource.", "DELETE.fabric.FcoeUplinkPcRole": "Delete a 'fabric.FcoeUplinkPcRole' resource.", "READ.fabric.FcoeUplinkPcRole": "Read a 'fabric.FcoeUplinkPcRole' resource.", "UPDATE.fabric.FcoeUplinkPcRole": "Update a 'fabric.FcoeUplinkPcRole' resource.", "CREATE.fabric.FcoeUplinkRole": "Create a 'fabric.FcoeUplinkRole' resource.", "DELETE.fabric.FcoeUplinkRole": "Delete a 'fabric.FcoeUplinkRole' resource.", "READ.fabric.FcoeUplinkRole": "Read a 'fabric.FcoeUplinkRole' resource.", "UPDATE.fabric.FcoeUplinkRole": "Update a 'fabric.FcoeUplinkRole' resource.", "CREATE.fabric.FlowControlPolicy": "Create a 'fabric.FlowControlPolicy' resource.", "DELETE.fabric.FlowControlPolicy": "Delete a 'fabric.FlowControlPolicy' resource.", "READ.fabric.FlowControlPolicy": "Read a 'fabric.FlowControlPolicy' resource.", "UPDATE.fabric.FlowControlPolicy": "Update a 'fabric.FlowControlPolicy' resource.", "CREATE.fabric.LanPinGroup": "Create a 'fabric.LanPinGroup' resource.", "DELETE.fabric.LanPinGroup": "Delete a 'fabric.LanPinGroup' resource.", "READ.fabric.LanPinGroup": "Read a 'fabric.LanPinGroup' resource.", "UPDATE.fabric.LanPinGroup": "Update a 'fabric.LanPinGroup' resource.", "CREATE.fabric.LinkAggregationPolicy": "Create a 'fabric.LinkAggregationPolicy' resource.", "DELETE.fabric.LinkAggregationPolicy": "Delete a 'fabric.LinkAggregationPolicy' resource.", "READ.fabric.LinkAggregationPolicy": "Read a 'fabric.LinkAggregationPolicy' resource.", "UPDATE.fabric.LinkAggregationPolicy": "Update a 'fabric.LinkAggregationPolicy' resource.", "CREATE.fabric.LinkControlPolicy": "Create a 'fabric.LinkControlPolicy' resource.", "DELETE.fabric.LinkControlPolicy": "Delete a 'fabric.LinkControlPolicy' resource.", "READ.fabric.LinkControlPolicy": "Read a 'fabric.LinkControlPolicy' resource.", "UPDATE.fabric.LinkControlPolicy": "Update a 'fabric.LinkControlPolicy' resource.", "CREATE.fabric.MacSecPolicy": "Create a 'fabric.MacSecPolicy' resource.", "DELETE.fabric.MacSecPolicy": "Delete a 'fabric.MacSecPolicy' resource.", "READ.fabric.MacSecPolicy": "Read a 'fabric.MacSecPolicy' resource.", "UPDATE.fabric.MacSecPolicy": "Update a 'fabric.MacSecPolicy' resource.", "CREATE.fabric.MulticastPolicy": "Create a 'fabric.MulticastPolicy' resource.", "DELETE.fabric.MulticastPolicy": "Delete a 'fabric.MulticastPolicy' resource.", "READ.fabric.MulticastPolicy": "Read a 'fabric.MulticastPolicy' resource.", "UPDATE.fabric.MulticastPolicy": "Update a 'fabric.MulticastPolicy' resource.", "CREATE.fabric.NetFlowExporter": "Create a 'fabric.NetFlowExporter' resource.", "DELETE.fabric.NetFlowExporter": "Delete a 'fabric.NetFlowExporter' resource.", "READ.fabric.NetFlowExporter": "Read a 'fabric.NetFlowExporter' resource.", "UPDATE.fabric.NetFlowExporter": "Update a 'fabric.NetFlowExporter' resource.", "CREATE.fabric.NetFlowMonitor": "Create a 'fabric.NetFlowMonitor' resource.", "DELETE.fabric.NetFlowMonitor": "Delete a 'fabric.NetFlowMonitor' resource.", "READ.fabric.NetFlowMonitor": "Read a 'fabric.NetFlowMonitor' resource.", "UPDATE.fabric.NetFlowMonitor": "Update a 'fabric.NetFlowMonitor' resource.", "CREATE.fabric.NetFlowPolicy": "Create a 'fabric.NetFlowPolicy' resource.", "DELETE.fabric.NetFlowPolicy": "Delete a 'fabric.NetFlowPolicy' resource.", "READ.fabric.NetFlowPolicy": "Read a 'fabric.NetFlowPolicy' resource.", "UPDATE.fabric.NetFlowPolicy": "Update a 'fabric.NetFlowPolicy' resource.", "CREATE.fabric.NetFlowRecord": "Create a 'fabric.NetFlowRecord' resource.", "DELETE.fabric.NetFlowRecord": "Delete a 'fabric.NetFlowRecord' resource.", "READ.fabric.NetFlowRecord": "Read a 'fabric.NetFlowRecord' resource.", "UPDATE.fabric.NetFlowRecord": "Update a 'fabric.NetFlowRecord' resource.", "READ.fabric.PcMember": "Read a 'fabric.PcMember' resource.", "CREATE.fabric.PcOperation": "Create a 'fabric.PcOperation' resource.", "DELETE.fabric.PcOperation": "Delete a 'fabric.PcOperation' resource.", "READ.fabric.PcOperation": "Read a 'fabric.PcOperation' resource.", "UPDATE.fabric.PcOperation": "Update a 'fabric.PcOperation' resource.", "CREATE.fabric.PortMode": "Create a 'fabric.PortMode' resource.", "DELETE.fabric.PortMode": "Delete a 'fabric.PortMode' resource.", "READ.fabric.PortMode": "Read a 'fabric.PortMode' resource.", "UPDATE.fabric.PortMode": "Update a 'fabric.PortMode' resource.", "CREATE.fabric.PortOperation": "Create a 'fabric.PortOperation' resource.", "DELETE.fabric.PortOperation": "Delete a 'fabric.PortOperation' resource.", "READ.fabric.PortOperation": "Read a 'fabric.PortOperation' resource.", "UPDATE.fabric.PortOperation": "Update a 'fabric.PortOperation' resource.", "CREATE.fabric.PortPolicy": "Create a 'fabric.PortPolicy' resource.", "DELETE.fabric.PortPolicy": "Delete a 'fabric.PortPolicy' resource.", "READ.fabric.PortPolicy": "Read a 'fabric.PortPolicy' resource.", "UPDATE.fabric.PortPolicy": "Update a 'fabric.PortPolicy' resource.", "CREATE.fabric.SanPinGroup": "Create a 'fabric.SanPinGroup' resource.", "DELETE.fabric.SanPinGroup": "Delete a 'fabric.SanPinGroup' resource.", "READ.fabric.SanPinGroup": "Read a 'fabric.SanPinGroup' resource.", "UPDATE.fabric.SanPinGroup": "Update a 'fabric.SanPinGroup' resource.", "CREATE.fabric.SecureRouterRole": "Create a 'fabric.SecureRouterRole' resource.", "DELETE.fabric.SecureRouterRole": "Delete a 'fabric.SecureRouterRole' resource.", "READ.fabric.SecureRouterRole": "Read a 'fabric.SecureRouterRole' resource.", "UPDATE.fabric.SecureRouterRole": "Update a 'fabric.SecureRouterRole' resource.", "CREATE.fabric.ServerRole": "Create a 'fabric.ServerRole' resource.", "DELETE.fabric.ServerRole": "Delete a 'fabric.ServerRole' resource.", "READ.fabric.ServerRole": "Read a 'fabric.ServerRole' resource.", "UPDATE.fabric.ServerRole": "Update a 'fabric.ServerRole' resource.", "CREATE.fabric.SpanDestEthPort": "Create a 'fabric.SpanDestEthPort' resource.", "DELETE.fabric.SpanDestEthPort": "Delete a 'fabric.SpanDestEthPort' resource.", "READ.fabric.SpanDestEthPort": "Read a 'fabric.SpanDestEthPort' resource.", "UPDATE.fabric.SpanDestEthPort": "Update a 'fabric.SpanDestEthPort' resource.", "CREATE.fabric.SpanSession": "Create a 'fabric.SpanSession' resource.", "DELETE.fabric.SpanSession": "Delete a 'fabric.SpanSession' resource.", "READ.fabric.SpanSession": "Read a 'fabric.SpanSession' resource.", "UPDATE.fabric.SpanSession": "Update a 'fabric.SpanSession' resource.", "CREATE.fabric.SpanSourceEthPort": "Create a 'fabric.SpanSourceEthPort' resource.", "DELETE.fabric.SpanSourceEthPort": "Delete a 'fabric.SpanSourceEthPort' resource.", "READ.fabric.SpanSourceEthPort": "Read a 'fabric.SpanSourceEthPort' resource.", "CREATE.fabric.SpanSourceEthPortChannel": "Create a 'fabric.SpanSourceEthPortChannel' resource.", "DELETE.fabric.SpanSourceEthPortChannel": "Delete a 'fabric.SpanSourceEthPortChannel' resource.", "READ.fabric.SpanSourceEthPortChannel": "Read a 'fabric.SpanSourceEthPortChannel' resource.", "CREATE.fabric.SpanSourceVlan": "Create a 'fabric.SpanSourceVlan' resource.", "DELETE.fabric.SpanSourceVlan": "Delete a 'fabric.SpanSourceVlan' resource.", "READ.fabric.SpanSourceVlan": "Read a 'fabric.SpanSourceVlan' resource.", "CREATE.fabric.SpanSourceVnicEthIf": "Create a 'fabric.SpanSourceVnicEthIf' resource.", "DELETE.fabric.SpanSourceVnicEthIf": "Delete a 'fabric.SpanSourceVnicEthIf' resource.", "READ.fabric.SpanSourceVnicEthIf": "Read a 'fabric.SpanSourceVnicEthIf' resource.", "CREATE.fabric.SwitchClusterProfile": "Create a 'fabric.SwitchClusterProfile' resource.", "DELETE.fabric.SwitchClusterProfile": "Delete a 'fabric.SwitchClusterProfile' resource.", "READ.fabric.SwitchClusterProfile": "Read a 'fabric.SwitchClusterProfile' resource.", "UPDATE.fabric.SwitchClusterProfile": "Update a 'fabric.SwitchClusterProfile' resource.", "CREATE.fabric.SwitchClusterProfileTemplate": "Create a 'fabric.SwitchClusterProfileTemplate' resource.", "DELETE.fabric.SwitchClusterProfileTemplate": "Delete a 'fabric.SwitchClusterProfileTemplate' resource.", "READ.fabric.SwitchClusterProfileTemplate": "Read a 'fabric.SwitchClusterProfileTemplate' resource.", "UPDATE.fabric.SwitchClusterProfileTemplate": "Update a 'fabric.SwitchClusterProfileTemplate' resource.", "CREATE.fabric.SwitchControlPolicy": "Create a 'fabric.SwitchControlPolicy' resource.", "DELETE.fabric.SwitchControlPolicy": "Delete a 'fabric.SwitchControlPolicy' resource.", "READ.fabric.SwitchControlPolicy": "Read a 'fabric.SwitchControlPolicy' resource.", "UPDATE.fabric.SwitchControlPolicy": "Update a 'fabric.SwitchControlPolicy' resource.", "CREATE.fabric.SwitchProfile": "Create a 'fabric.SwitchProfile' resource.", "DELETE.fabric.SwitchProfile": "Delete a 'fabric.SwitchProfile' resource.", "READ.fabric.SwitchProfile": "Read a 'fabric.SwitchProfile' resource.", "UPDATE.fabric.SwitchProfile": "Update a 'fabric.SwitchProfile' resource.", "CREATE.fabric.SwitchProfileTemplate": "Create a 'fabric.SwitchProfileTemplate' resource.", "DELETE.fabric.SwitchProfileTemplate": "Delete a 'fabric.SwitchProfileTemplate' resource.", "READ.fabric.SwitchProfileTemplate": "Read a 'fabric.SwitchProfileTemplate' resource.", "UPDATE.fabric.SwitchProfileTemplate": "Update a 'fabric.SwitchProfileTemplate' resource.", "CREATE.fabric.SystemQosPolicy": "Create a 'fabric.SystemQosPolicy' resource.", "DELETE.fabric.SystemQosPolicy": "Delete a 'fabric.SystemQosPolicy' resource.", "READ.fabric.SystemQosPolicy": "Read a 'fabric.SystemQosPolicy' resource.", "UPDATE.fabric.SystemQosPolicy": "Update a 'fabric.SystemQosPolicy' resource.", "CREATE.fabric.UplinkPcRole": "Create a 'fabric.UplinkPcRole' resource.", "DELETE.fabric.UplinkPcRole": "Delete a 'fabric.UplinkPcRole' resource.", "READ.fabric.UplinkPcRole": "Read a 'fabric.UplinkPcRole' resource.", "UPDATE.fabric.UplinkPcRole": "Update a 'fabric.UplinkPcRole' resource.", "CREATE.fabric.UplinkRole": "Create a 'fabric.UplinkRole' resource.", "DELETE.fabric.UplinkRole": "Delete a 'fabric.UplinkRole' resource.", "READ.fabric.UplinkRole": "Read a 'fabric.UplinkRole' resource.", "UPDATE.fabric.UplinkRole": "Update a 'fabric.UplinkRole' resource.", "CREATE.fabric.Vlan": "Create a 'fabric.Vlan' resource.", "DELETE.fabric.Vlan": "Delete a 'fabric.Vlan' resource.", "READ.fabric.Vlan": "Read a 'fabric.Vlan' resource.", "UPDATE.fabric.Vlan": "Update a 'fabric.Vlan' resource.", "READ.fabric.VlanInventory": "Read a 'fabric.VlanInventory' resource.", "READ.fabric.VlanSet": "Read a 'fabric.VlanSet' resource.", "CREATE.fabric.Vsan": "Create a 'fabric.Vsan' resource.", "DELETE.fabric.Vsan": "Delete a 'fabric.Vsan' resource.", "READ.fabric.Vsan": "Read a 'fabric.Vsan' resource.", "UPDATE.fabric.Vsan": "Update a 'fabric.Vsan' resource.", "READ.fabric.VsanInventory": "Read a 'fabric.VsanInventory' resource.", "READ.fault.Instance": "Read a 'fault.Instance' resource.", "UPDATE.fault.Instance": "Update a 'fault.Instance' resource.", "READ.fc.Neighbor": "Read a 'fc.Neighbor' resource.", "READ.fc.PhysicalPort": "Read a 'fc.PhysicalPort' resource.", "UPDATE.fc.PhysicalPort": "Update a 'fc.PhysicalPort' resource.", "READ.fc.PortChannel": "Read a 'fc.PortChannel' resource.", "READ.fcpool.FcBlock": "Read a 'fcpool.FcBlock' resource.", "DELETE.fcpool.Lease": "Delete a 'fcpool.Lease' resource.", "READ.fcpool.Lease": "Read a 'fcpool.Lease' resource.", "CREATE.fcpool.Pool": "Create a 'fcpool.Pool' resource.", "DELETE.fcpool.Pool": "Delete a 'fcpool.Pool' resource.", "READ.fcpool.Pool": "Read a 'fcpool.Pool' resource.", "UPDATE.fcpool.Pool": "Update a 'fcpool.Pool' resource.", "READ.fcpool.PoolMember": "Read a 'fcpool.PoolMember' resource.", "CREATE.fcpool.Reservation": "Create a 'fcpool.Reservation' resource.", "DELETE.fcpool.Reservation": "Delete a 'fcpool.Reservation' resource.", "READ.fcpool.Reservation": "Read a 'fcpool.Reservation' resource.", "UPDATE.fcpool.Reservation": "Update a 'fcpool.Reservation' resource.", "READ.fcpool.Universe": "Read a 'fcpool.Universe' resource.", "CREATE.feedback.FeedbackPost": "Create a 'feedback.FeedbackPost' resource.", "UPDATE.feedback.FeedbackPost": "Update a 'feedback.FeedbackPost' resource.", "READ.firmware.BiosDescriptor": "Read a 'firmware.BiosDescriptor' resource.", "READ.firmware.BoardControllerDescriptor": "Read a 'firmware.BoardControllerDescriptor' resource.", "CREATE.firmware.ChassisUpgrade": "Create a 'firmware.ChassisUpgrade' resource.", "DELETE.firmware.ChassisUpgrade": "Delete a 'firmware.ChassisUpgrade' resource.", "READ.firmware.ChassisUpgrade": "Read a 'firmware.ChassisUpgrade' resource.", "READ.firmware.CimcDescriptor": "Read a 'firmware.CimcDescriptor' resource.", "READ.firmware.DimmDescriptor": "Read a 'firmware.DimmDescriptor' resource.", "CREATE.firmware.Distributable": "Create a 'firmware.Distributable' resource.", "DELETE.firmware.Distributable": "Delete a 'firmware.Distributable' resource.", "READ.firmware.Distributable": "Read a 'firmware.Distributable' resource.", "UPDATE.firmware.Distributable": "Update a 'firmware.Distributable' resource.", "READ.firmware.DistributableMeta": "Read a 'firmware.DistributableMeta' resource.", "READ.firmware.DriveDescriptor": "Read a 'firmware.DriveDescriptor' resource.", "CREATE.firmware.DriverDistributable": "Create a 'firmware.DriverDistributable' resource.", "DELETE.firmware.DriverDistributable": "Delete a 'firmware.DriverDistributable' resource.", "READ.firmware.DriverDistributable": "Read a 'firmware.DriverDistributable' resource.", "UPDATE.firmware.DriverDistributable": "Update a 'firmware.DriverDistributable' resource.", "CREATE.firmware.Eula": "Create a 'firmware.Eula' resource.", "READ.firmware.Eula": "Read a 'firmware.Eula' resource.", "READ.firmware.FirmwareSummary": "Read a 'firmware.FirmwareSummary' resource.", "READ.firmware.GpuDescriptor": "Read a 'firmware.GpuDescriptor' resource.", "READ.firmware.HbaDescriptor": "Read a 'firmware.HbaDescriptor' resource.", "READ.firmware.IomDescriptor": "Read a 'firmware.IomDescriptor' resource.", "READ.firmware.MswitchDescriptor": "Read a 'firmware.MswitchDescriptor' resource.", "READ.firmware.NxosDescriptor": "Read a 'firmware.NxosDescriptor' resource.", "CREATE.firmware.PciNodeUpgrade": "Create a 'firmware.PciNodeUpgrade' resource.", "DELETE.firmware.PciNodeUpgrade": "Delete a 'firmware.PciNodeUpgrade' resource.", "READ.firmware.PciNodeUpgrade": "Read a 'firmware.PciNodeUpgrade' resource.", "READ.firmware.PcieDescriptor": "Read a 'firmware.PcieDescriptor' resource.", "CREATE.firmware.Policy": "Create a 'firmware.Policy' resource.", "DELETE.firmware.Policy": "Delete a 'firmware.Policy' resource.", "READ.firmware.Policy": "Read a 'firmware.Policy' resource.", "UPDATE.firmware.Policy": "Update a 'firmware.Policy' resource.", "READ.firmware.PsuDescriptor": "Read a 'firmware.PsuDescriptor' resource.", "READ.firmware.PsxDescriptor": "Read a 'firmware.PsxDescriptor' resource.", "READ.firmware.RunningFirmware": "Read a 'firmware.RunningFirmware' resource.", "UPDATE.firmware.RunningFirmware": "Update a 'firmware.RunningFirmware' resource.", "READ.firmware.SasExpanderDescriptor": "Read a 'firmware.SasExpanderDescriptor' resource.", "CREATE.firmware.SecureRouterUpgrade": "Create a 'firmware.SecureRouterUpgrade' resource.", "DELETE.firmware.SecureRouterUpgrade": "Delete a 'firmware.SecureRouterUpgrade' resource.", "READ.firmware.SecureRouterUpgrade": "Read a 'firmware.SecureRouterUpgrade' resource.", "CREATE.firmware.ServerConfigurationUtilityDistributable": "Create a 'firmware.ServerConfigurationUtilityDistributable' resource.", "DELETE.firmware.ServerConfigurationUtilityDistributable": "Delete a 'firmware.ServerConfigurationUtilityDistributable' resource.", "READ.firmware.ServerConfigurationUtilityDistributable": "Read a 'firmware.ServerConfigurationUtilityDistributable' resource.", "UPDATE.firmware.ServerConfigurationUtilityDistributable": "Update a 'firmware.ServerConfigurationUtilityDistributable' resource.", "READ.firmware.StorageControllerDescriptor": "Read a 'firmware.StorageControllerDescriptor' resource.", "CREATE.firmware.SwitchUpgrade": "Create a 'firmware.SwitchUpgrade' resource.", "DELETE.firmware.SwitchUpgrade": "Delete a 'firmware.SwitchUpgrade' resource.", "READ.firmware.SwitchUpgrade": "Read a 'firmware.SwitchUpgrade' resource.", "CREATE.firmware.UnsupportedVersionUpgrade": "Create a 'firmware.UnsupportedVersionUpgrade' resource.", "DELETE.firmware.UnsupportedVersionUpgrade": "Delete a 'firmware.UnsupportedVersionUpgrade' resource.", "READ.firmware.UnsupportedVersionUpgrade": "Read a 'firmware.UnsupportedVersionUpgrade' resource.", "UPDATE.firmware.UnsupportedVersionUpgrade": "Update a 'firmware.UnsupportedVersionUpgrade' resource.", "CREATE.firmware.Upgrade": "Create a 'firmware.Upgrade' resource.", "DELETE.firmware.Upgrade": "Delete a 'firmware.Upgrade' resource.", "READ.firmware.Upgrade": "Read a 'firmware.Upgrade' resource.", "UPDATE.firmware.Upgrade": "Update a 'firmware.Upgrade' resource.", "CREATE.firmware.UpgradeImpact": "Create a 'firmware.UpgradeImpact' resource.", "READ.firmware.UpgradeImpactStatus": "Read a 'firmware.UpgradeImpactStatus' resource.", "READ.firmware.UpgradeStatus": "Read a 'firmware.UpgradeStatus' resource.", "CREATE.firmware.UpgradeValidity": "Create a 'firmware.UpgradeValidity' resource.", "READ.fmc.Device": "Read a 'fmc.Device' resource.", "READ.fmc.DeviceHaPair": "Read a 'fmc.DeviceHaPair' resource.", "READ.fmc.Domain": "Read a 'fmc.Domain' resource.", "READ.fmc.PhysicalInterface": "Read a 'fmc.PhysicalInterface' resource.", "READ.forecast.Catalog": "Read a 'forecast.Catalog' resource.", "READ.forecast.Definition": "Read a 'forecast.Definition' resource.", "READ.forecast.Instance": "Read a 'forecast.Instance' resource.", "UPDATE.forecast.Instance": "Update a 'forecast.Instance' resource.", "READ.graphics.Card": "Read a 'graphics.Card' resource.", "UPDATE.graphics.Card": "Update a 'graphics.Card' resource.", "READ.graphics.Controller": "Read a 'graphics.Controller' resource.", "UPDATE.graphics.Controller": "Update a 'graphics.Controller' resource.", "READ.hci.AhvVm": "Read a 'hci.AhvVm' resource.", "UPDATE.hci.AhvVm": "Update a 'hci.AhvVm' resource.", "READ.hci.AhvVmDisk": "Read a 'hci.AhvVmDisk' resource.", "READ.hci.AhvVmGpu": "Read a 'hci.AhvVmGpu' resource.", "READ.hci.AhvVmNic": "Read a 'hci.AhvVmNic' resource.", "READ.hci.Alarm": "Read a 'hci.Alarm' resource.", "READ.hci.Cluster": "Read a 'hci.Cluster' resource.", "UPDATE.hci.Cluster": "Update a 'hci.Cluster' resource.", "READ.hci.ClusterOperation": "Read a 'hci.ClusterOperation' resource.", "UPDATE.hci.ClusterOperation": "Update a 'hci.ClusterOperation' resource.", "READ.hci.Compliance": "Read a 'hci.Compliance' resource.", "READ.hci.Disk": "Read a 'hci.Disk' resource.", "READ.hci.DomainManager": "Read a 'hci.DomainManager' resource.", "READ.hci.Entitlement": "Read a 'hci.Entitlement' resource.", "READ.hci.EsxiVm": "Read a 'hci.EsxiVm' resource.", "UPDATE.hci.EsxiVm": "Update a 'hci.EsxiVm' resource.", "READ.hci.EsxiVmDisk": "Read a 'hci.EsxiVmDisk' resource.", "READ.hci.EsxiVmNic": "Read a 'hci.EsxiVmNic' resource.", "READ.hci.ExternalStorage": "Read a 'hci.ExternalStorage' resource.", "READ.hci.Gpu": "Read a 'hci.Gpu' resource.", "READ.hci.License": "Read a 'hci.License' resource.", "READ.hci.NccCheckPolicy": "Read a 'hci.NccCheckPolicy' resource.", "READ.hci.Node": "Read a 'hci.Node' resource.", "UPDATE.hci.Node": "Update a 'hci.Node' resource.", "READ.hci.PhysicalGpu": "Read a 'hci.PhysicalGpu' resource.", "READ.hci.StorageContainer": "Read a 'hci.StorageContainer' resource.", "READ.hci.Violation": "Read a 'hci.Violation' resource.", "READ.hci.VirtualGpu": "Read a 'hci.VirtualGpu' resource.", "CREATE.hcl.CompatibilityStatus": "Create a 'hcl.CompatibilityStatus' resource.", "READ.hcl.DataImportLog": "Read a 'hcl.DataImportLog' resource.", "READ.hcl.DriverImage": "Read a 'hcl.DriverImage' resource.", "READ.hcl.ExemptedCatalog": "Read a 'hcl.ExemptedCatalog' resource.", "READ.hcl.HwCatalogInfo": "Read a 'hcl.HwCatalogInfo' resource.", "READ.hcl.HyperflexSoftwareCompatibilityInfo": "Read a 'hcl.HyperflexSoftwareCompatibilityInfo' resource.", "READ.hcl.OperatingSystem": "Read a 'hcl.OperatingSystem' resource.", "READ.hcl.OperatingSystemVendor": "Read a 'hcl.OperatingSystemVendor' resource.", "READ.hcl.ServerCatalog": "Read a 'hcl.ServerCatalog' resource.", "READ.hcl.ServerHwCatalogInfo": "Read a 'hcl.ServerHwCatalogInfo' resource.", "CREATE.hcl.SupportedDriverName": "Create a 'hcl.SupportedDriverName' resource.", "READ.hyperflex.Alarm": "Read a 'hyperflex.Alarm' resource.", "READ.hyperflex.AppCatalog": "Read a 'hyperflex.AppCatalog' resource.", "CREATE.hyperflex.AutoSupportPolicy": "Create a 'hyperflex.AutoSupportPolicy' resource.", "DELETE.hyperflex.AutoSupportPolicy": "Delete a 'hyperflex.AutoSupportPolicy' resource.", "READ.hyperflex.AutoSupportPolicy": "Read a 'hyperflex.AutoSupportPolicy' resource.", "UPDATE.hyperflex.AutoSupportPolicy": "Update a 'hyperflex.AutoSupportPolicy' resource.", "DELETE.hyperflex.BackupCluster": "Delete a 'hyperflex.BackupCluster' resource.", "READ.hyperflex.BackupCluster": "Read a 'hyperflex.BackupCluster' resource.", "CREATE.hyperflex.CapabilityInfo": "Create a 'hyperflex.CapabilityInfo' resource.", "READ.hyperflex.CapabilityInfo": "Read a 'hyperflex.CapabilityInfo' resource.", "UPDATE.hyperflex.CapabilityInfo": "Update a 'hyperflex.CapabilityInfo' resource.", "READ.hyperflex.Cluster": "Read a 'hyperflex.Cluster' resource.", "UPDATE.hyperflex.Cluster": "Update a 'hyperflex.Cluster' resource.", "CREATE.hyperflex.ClusterBackupPolicy": "Create a 'hyperflex.ClusterBackupPolicy' resource.", "DELETE.hyperflex.ClusterBackupPolicy": "Delete a 'hyperflex.ClusterBackupPolicy' resource.", "READ.hyperflex.ClusterBackupPolicy": "Read a 'hyperflex.ClusterBackupPolicy' resource.", "UPDATE.hyperflex.ClusterBackupPolicy": "Update a 'hyperflex.ClusterBackupPolicy' resource.", "CREATE.hyperflex.ClusterBackupPolicyDeployment": "Create a 'hyperflex.ClusterBackupPolicyDeployment' resource.", "DELETE.hyperflex.ClusterBackupPolicyDeployment": "Delete a 'hyperflex.ClusterBackupPolicyDeployment' resource.", "READ.hyperflex.ClusterBackupPolicyDeployment": "Read a 'hyperflex.ClusterBackupPolicyDeployment' resource.", "UPDATE.hyperflex.ClusterBackupPolicyDeployment": "Update a 'hyperflex.ClusterBackupPolicyDeployment' resource.", "DELETE.hyperflex.ClusterBackupPolicyInventory": "Delete a 'hyperflex.ClusterBackupPolicyInventory' resource.", "READ.hyperflex.ClusterBackupPolicyInventory": "Read a 'hyperflex.ClusterBackupPolicyInventory' resource.", "READ.hyperflex.ClusterHealthCheckExecutionSnapshot": "Read a 'hyperflex.ClusterHealthCheckExecutionSnapshot' resource.", "CREATE.hyperflex.ClusterNetworkPolicy": "Create a 'hyperflex.ClusterNetworkPolicy' resource.", "DELETE.hyperflex.ClusterNetworkPolicy": "Delete a 'hyperflex.ClusterNetworkPolicy' resource.", "READ.hyperflex.ClusterNetworkPolicy": "Read a 'hyperflex.ClusterNetworkPolicy' resource.", "UPDATE.hyperflex.ClusterNetworkPolicy": "Update a 'hyperflex.ClusterNetworkPolicy' resource.", "CREATE.hyperflex.ClusterProfile": "Create a 'hyperflex.ClusterProfile' resource.", "DELETE.hyperflex.ClusterProfile": "Delete a 'hyperflex.ClusterProfile' resource.", "READ.hyperflex.ClusterProfile": "Read a 'hyperflex.ClusterProfile' resource.", "UPDATE.hyperflex.ClusterProfile": "Update a 'hyperflex.ClusterProfile' resource.", "CREATE.hyperflex.ClusterReplicationNetworkPolicy": "Create a 'hyperflex.ClusterReplicationNetworkPolicy' resource.", "DELETE.hyperflex.ClusterReplicationNetworkPolicy": "Delete a 'hyperflex.ClusterReplicationNetworkPolicy' resource.", "READ.hyperflex.ClusterReplicationNetworkPolicy": "Read a 'hyperflex.ClusterReplicationNetworkPolicy' resource.", "UPDATE.hyperflex.ClusterReplicationNetworkPolicy": "Update a 'hyperflex.ClusterReplicationNetworkPolicy' resource.", "CREATE.hyperflex.ClusterReplicationNetworkPolicyDeployment": "Create a 'hyperflex.ClusterReplicationNetworkPolicyDeployment' resource.", "DELETE.hyperflex.ClusterReplicationNetworkPolicyDeployment": "Delete a 'hyperflex.ClusterReplicationNetworkPolicyDeployment' resource.", "READ.hyperflex.ClusterReplicationNetworkPolicyDeployment": "Read a 'hyperflex.ClusterReplicationNetworkPolicyDeployment' resource.", "UPDATE.hyperflex.ClusterReplicationNetworkPolicyDeployment": "Update a 'hyperflex.ClusterReplicationNetworkPolicyDeployment' resource.", "CREATE.hyperflex.ClusterStoragePolicy": "Create a 'hyperflex.ClusterStoragePolicy' resource.", "DELETE.hyperflex.ClusterStoragePolicy": "Delete a 'hyperflex.ClusterStoragePolicy' resource.", "READ.hyperflex.ClusterStoragePolicy": "Read a 'hyperflex.ClusterStoragePolicy' resource.", "UPDATE.hyperflex.ClusterStoragePolicy": "Update a 'hyperflex.ClusterStoragePolicy' resource.", "READ.hyperflex.ConfigResult": "Read a 'hyperflex.ConfigResult' resource.", "READ.hyperflex.ConfigResultEntry": "Read a 'hyperflex.ConfigResultEntry' resource.", "READ.hyperflex.DataProtectionPeer": "Read a 'hyperflex.DataProtectionPeer' resource.", "READ.hyperflex.DatastoreStatistic": "Read a 'hyperflex.DatastoreStatistic' resource.", "READ.hyperflex.DevicePackageDownloadState": "Read a 'hyperflex.DevicePackageDownloadState' resource.", "READ.hyperflex.Drive": "Read a 'hyperflex.Drive' resource.", "UPDATE.hyperflex.Drive": "Update a 'hyperflex.Drive' resource.", "READ.hyperflex.Encryption": "Read a 'hyperflex.Encryption' resource.", "CREATE.hyperflex.ExtFcStoragePolicy": "Create a 'hyperflex.ExtFcStoragePolicy' resource.", "DELETE.hyperflex.ExtFcStoragePolicy": "Delete a 'hyperflex.ExtFcStoragePolicy' resource.", "READ.hyperflex.ExtFcStoragePolicy": "Read a 'hyperflex.ExtFcStoragePolicy' resource.", "UPDATE.hyperflex.ExtFcStoragePolicy": "Update a 'hyperflex.ExtFcStoragePolicy' resource.", "CREATE.hyperflex.ExtIscsiStoragePolicy": "Create a 'hyperflex.ExtIscsiStoragePolicy' resource.", "DELETE.hyperflex.ExtIscsiStoragePolicy": "Delete a 'hyperflex.ExtIscsiStoragePolicy' resource.", "READ.hyperflex.ExtIscsiStoragePolicy": "Read a 'hyperflex.ExtIscsiStoragePolicy' resource.", "UPDATE.hyperflex.ExtIscsiStoragePolicy": "Update a 'hyperflex.ExtIscsiStoragePolicy' resource.", "READ.hyperflex.FeatureLimitExternal": "Read a 'hyperflex.FeatureLimitExternal' resource.", "READ.hyperflex.FeatureLimitInternal": "Read a 'hyperflex.FeatureLimitInternal' resource.", "READ.hyperflex.Health": "Read a 'hyperflex.Health' resource.", "READ.hyperflex.HealthCheckDefinition": "Read a 'hyperflex.HealthCheckDefinition' resource.", "READ.hyperflex.HealthCheckExecution": "Read a 'hyperflex.HealthCheckExecution' resource.", "READ.hyperflex.HealthCheckExecutionSnapshot": "Read a 'hyperflex.HealthCheckExecutionSnapshot' resource.", "READ.hyperflex.HealthCheckPackageChecksum": "Read a 'hyperflex.HealthCheckPackageChecksum' resource.", "READ.hyperflex.HealthCheckSchedulePolicy": "Read a 'hyperflex.HealthCheckSchedulePolicy' resource.", "READ.hyperflex.HwCatalog": "Read a 'hyperflex.HwCatalog' resource.", "READ.hyperflex.HxdpVersion": "Read a 'hyperflex.HxdpVersion' resource.", "READ.hyperflex.HypervisorHost": "Read a 'hyperflex.HypervisorHost' resource.", "UPDATE.hyperflex.HypervisorHost": "Update a 'hyperflex.HypervisorHost' resource.", "READ.hyperflex.HypervisorVirtualMachine": "Read a 'hyperflex.HypervisorVirtualMachine' resource.", "UPDATE.hyperflex.HypervisorVirtualMachine": "Update a 'hyperflex.HypervisorVirtualMachine' resource.", "READ.hyperflex.InitiatorGroup": "Read a 'hyperflex.InitiatorGroup' resource.", "UPDATE.hyperflex.InitiatorGroup": "Update a 'hyperflex.InitiatorGroup' resource.", "READ.hyperflex.IscsiNetwork": "Read a 'hyperflex.IscsiNetwork' resource.", "UPDATE.hyperflex.IscsiNetwork": "Update a 'hyperflex.IscsiNetwork' resource.", "CREATE.hyperflex.KeyEncryptionKey": "Create a 'hyperflex.KeyEncryptionKey' resource.", "DELETE.hyperflex.KeyEncryptionKey": "Delete a 'hyperflex.KeyEncryptionKey' resource.", "READ.hyperflex.KeyEncryptionKey": "Read a 'hyperflex.KeyEncryptionKey' resource.", "UPDATE.hyperflex.KeyEncryptionKey": "Update a 'hyperflex.KeyEncryptionKey' resource.", "READ.hyperflex.License": "Read a 'hyperflex.License' resource.", "CREATE.hyperflex.LocalCredentialPolicy": "Create a 'hyperflex.LocalCredentialPolicy' resource.", "DELETE.hyperflex.LocalCredentialPolicy": "Delete a 'hyperflex.LocalCredentialPolicy' resource.", "READ.hyperflex.LocalCredentialPolicy": "Read a 'hyperflex.LocalCredentialPolicy' resource.", "UPDATE.hyperflex.LocalCredentialPolicy": "Update a 'hyperflex.LocalCredentialPolicy' resource.", "READ.hyperflex.Lun": "Read a 'hyperflex.Lun' resource.", "UPDATE.hyperflex.Lun": "Update a 'hyperflex.Lun' resource.", "READ.hyperflex.Node": "Read a 'hyperflex.Node' resource.", "CREATE.hyperflex.NodeConfigPolicy": "Create a 'hyperflex.NodeConfigPolicy' resource.", "DELETE.hyperflex.NodeConfigPolicy": "Delete a 'hyperflex.NodeConfigPolicy' resource.", "READ.hyperflex.NodeConfigPolicy": "Read a 'hyperflex.NodeConfigPolicy' resource.", "UPDATE.hyperflex.NodeConfigPolicy": "Update a 'hyperflex.NodeConfigPolicy' resource.", "CREATE.hyperflex.NodeProfile": "Create a 'hyperflex.NodeProfile' resource.", "DELETE.hyperflex.NodeProfile": "Delete a 'hyperflex.NodeProfile' resource.", "READ.hyperflex.NodeProfile": "Read a 'hyperflex.NodeProfile' resource.", "UPDATE.hyperflex.NodeProfile": "Update a 'hyperflex.NodeProfile' resource.", "READ.hyperflex.ProtectedCluster": "Read a 'hyperflex.ProtectedCluster' resource.", "CREATE.hyperflex.ProxySettingPolicy": "Create a 'hyperflex.ProxySettingPolicy' resource.", "DELETE.hyperflex.ProxySettingPolicy": "Delete a 'hyperflex.ProxySettingPolicy' resource.", "READ.hyperflex.ProxySettingPolicy": "Read a 'hyperflex.ProxySettingPolicy' resource.", "UPDATE.hyperflex.ProxySettingPolicy": "Update a 'hyperflex.ProxySettingPolicy' resource.", "CREATE.hyperflex.ReduceReSync": "Create a 'hyperflex.ReduceReSync' resource.", "READ.hyperflex.ReduceReSync": "Read a 'hyperflex.ReduceReSync' resource.", "UPDATE.hyperflex.ReduceReSync": "Update a 'hyperflex.ReduceReSync' resource.", "READ.hyperflex.ServerFirmwareVersion": "Read a 'hyperflex.ServerFirmwareVersion' resource.", "READ.hyperflex.ServerFirmwareVersionEntry": "Read a 'hyperflex.ServerFirmwareVersionEntry' resource.", "READ.hyperflex.ServerModel": "Read a 'hyperflex.ServerModel' resource.", "CREATE.hyperflex.ServiceAuthToken": "Create a 'hyperflex.ServiceAuthToken' resource.", "DELETE.hyperflex.ServiceAuthToken": "Delete a 'hyperflex.ServiceAuthToken' resource.", "READ.hyperflex.ServiceAuthToken": "Read a 'hyperflex.ServiceAuthToken' resource.", "UPDATE.hyperflex.ServiceAuthToken": "Update a 'hyperflex.ServiceAuthToken' resource.", "READ.hyperflex.SoftwareDistributionComponent": "Read a 'hyperflex.SoftwareDistributionComponent' resource.", "READ.hyperflex.SoftwareDistributionEntry": "Read a 'hyperflex.SoftwareDistributionEntry' resource.", "READ.hyperflex.SoftwareDistributionVersion": "Read a 'hyperflex.SoftwareDistributionVersion' resource.", "CREATE.hyperflex.SoftwareVersionPolicy": "Create a 'hyperflex.SoftwareVersionPolicy' resource.", "DELETE.hyperflex.SoftwareVersionPolicy": "Delete a 'hyperflex.SoftwareVersionPolicy' resource.", "READ.hyperflex.SoftwareVersionPolicy": "Read a 'hyperflex.SoftwareVersionPolicy' resource.", "UPDATE.hyperflex.SoftwareVersionPolicy": "Update a 'hyperflex.SoftwareVersionPolicy' resource.", "CREATE.hyperflex.StartReduceReSync": "Create a 'hyperflex.StartReduceReSync' resource.", "READ.hyperflex.StartReduceReSync": "Read a 'hyperflex.StartReduceReSync' resource.", "READ.hyperflex.StorageContainer": "Read a 'hyperflex.StorageContainer' resource.", "UPDATE.hyperflex.StorageContainer": "Update a 'hyperflex.StorageContainer' resource.", "CREATE.hyperflex.SysConfigPolicy": "Create a 'hyperflex.SysConfigPolicy' resource.", "DELETE.hyperflex.SysConfigPolicy": "Delete a 'hyperflex.SysConfigPolicy' resource.", "READ.hyperflex.SysConfigPolicy": "Read a 'hyperflex.SysConfigPolicy' resource.", "UPDATE.hyperflex.SysConfigPolicy": "Update a 'hyperflex.SysConfigPolicy' resource.", "READ.hyperflex.Target": "Read a 'hyperflex.Target' resource.", "UPDATE.hyperflex.Target": "Update a 'hyperflex.Target' resource.", "CREATE.hyperflex.UcsmConfigPolicy": "Create a 'hyperflex.UcsmConfigPolicy' resource.", "DELETE.hyperflex.UcsmConfigPolicy": "Delete a 'hyperflex.UcsmConfigPolicy' resource.", "READ.hyperflex.UcsmConfigPolicy": "Read a 'hyperflex.UcsmConfigPolicy' resource.", "UPDATE.hyperflex.UcsmConfigPolicy": "Update a 'hyperflex.UcsmConfigPolicy' resource.", "CREATE.hyperflex.VcenterConfigPolicy": "Create a 'hyperflex.VcenterConfigPolicy' resource.", "DELETE.hyperflex.VcenterConfigPolicy": "Delete a 'hyperflex.VcenterConfigPolicy' resource.", "READ.hyperflex.VcenterConfigPolicy": "Read a 'hyperflex.VcenterConfigPolicy' resource.", "UPDATE.hyperflex.VcenterConfigPolicy": "Update a 'hyperflex.VcenterConfigPolicy' resource.", "DELETE.hyperflex.VmBackupInfo": "Delete a 'hyperflex.VmBackupInfo' resource.", "READ.hyperflex.VmBackupInfo": "Read a 'hyperflex.VmBackupInfo' resource.", "CREATE.hyperflex.VmImportOperation": "Create a 'hyperflex.VmImportOperation' resource.", "DELETE.hyperflex.VmImportOperation": "Delete a 'hyperflex.VmImportOperation' resource.", "READ.hyperflex.VmImportOperation": "Read a 'hyperflex.VmImportOperation' resource.", "CREATE.hyperflex.VmRestoreOperation": "Create a 'hyperflex.VmRestoreOperation' resource.", "DELETE.hyperflex.VmRestoreOperation": "Delete a 'hyperflex.VmRestoreOperation' resource.", "READ.hyperflex.VmRestoreOperation": "Read a 'hyperflex.VmRestoreOperation' resource.", "DELETE.hyperflex.VmSnapshotInfo": "Delete a 'hyperflex.VmSnapshotInfo' resource.", "READ.hyperflex.VmSnapshotInfo": "Read a 'hyperflex.VmSnapshotInfo' resource.", "READ.hyperflex.Volume": "Read a 'hyperflex.Volume' resource.", "UPDATE.hyperflex.Volume": "Update a 'hyperflex.Volume' resource.", "READ.hyperflex.WitnessConfiguration": "Read a 'hyperflex.WitnessConfiguration' resource.", "READ.iaas.ConnectorPack": "Read a 'iaas.ConnectorPack' resource.", "READ.iaas.CustomTaskInfo": "Read a 'iaas.CustomTaskInfo' resource.", "READ.iaas.DeviceStatus": "Read a 'iaas.DeviceStatus' resource.", "READ.iaas.DiagnosticMessages": "Read a 'iaas.DiagnosticMessages' resource.", "READ.iaas.LicenseInfo": "Read a 'iaas.LicenseInfo' resource.", "READ.iaas.MostRunTasks": "Read a 'iaas.MostRunTasks' resource.", "READ.iaas.ServiceRequest": "Read a 'iaas.ServiceRequest' resource.", "READ.iaas.SystemTaskInfo": "Read a 'iaas.SystemTaskInfo' resource.", "READ.iaas.UcsdInfo": "Read a 'iaas.UcsdInfo' resource.", "UPDATE.iaas.UcsdInfo": "Update a 'iaas.UcsdInfo' resource.", "READ.iaas.UcsdManagedInfra": "Read a 'iaas.UcsdManagedInfra' resource.", "READ.iaas.UcsdMessages": "Read a 'iaas.UcsdMessages' resource.", "CREATE.iam.Account": "Create a 'iam.Account' resource.", "DELETE.iam.Account": "Delete a 'iam.Account' resource.", "READ.iam.Account": "Read a 'iam.Account' resource.", "UPDATE.iam.Account": "Update a 'iam.Account' resource.", "READ.iam.AccountExperience": "Read a 'iam.AccountExperience' resource.", "CREATE.iam.ApiKey": "Create a 'iam.ApiKey' resource.", "DELETE.iam.ApiKey": "Delete a 'iam.ApiKey' resource.", "READ.iam.ApiKey": "Read a 'iam.ApiKey' resource.", "UPDATE.iam.ApiKey": "Update a 'iam.ApiKey' resource.", "CREATE.iam.AppRegistration": "Create a 'iam.AppRegistration' resource.", "DELETE.iam.AppRegistration": "Delete a 'iam.AppRegistration' resource.", "READ.iam.AppRegistration": "Read a 'iam.AppRegistration' resource.", "UPDATE.iam.AppRegistration": "Update a 'iam.AppRegistration' resource.", "READ.iam.BannerMessage": "Read a 'iam.BannerMessage' resource.", "UPDATE.iam.BannerMessage": "Update a 'iam.BannerMessage' resource.", "CREATE.iam.Certificate": "Create a 'iam.Certificate' resource.", "DELETE.iam.Certificate": "Delete a 'iam.Certificate' resource.", "READ.iam.Certificate": "Read a 'iam.Certificate' resource.", "UPDATE.iam.Certificate": "Update a 'iam.Certificate' resource.", "CREATE.iam.CertificateRequest": "Create a 'iam.CertificateRequest' resource.", "DELETE.iam.CertificateRequest": "Delete a 'iam.CertificateRequest' resource.", "READ.iam.CertificateRequest": "Read a 'iam.CertificateRequest' resource.", "UPDATE.iam.CertificateRequest": "Update a 'iam.CertificateRequest' resource.", "CREATE.iam.CuiIntegration": "Create a 'iam.CuiIntegration' resource.", "READ.iam.CuiIntegration": "Read a 'iam.CuiIntegration' resource.", "UPDATE.iam.CuiIntegration": "Update a 'iam.CuiIntegration' resource.", "READ.iam.DefaultAuthentication": "Read a 'iam.DefaultAuthentication' resource.", "UPDATE.iam.DefaultAuthentication": "Update a 'iam.DefaultAuthentication' resource.", "READ.iam.DomainGroup": "Read a 'iam.DomainGroup' resource.", "CREATE.iam.DomainNameInfo": "Create a 'iam.DomainNameInfo' resource.", "DELETE.iam.DomainNameInfo": "Delete a 'iam.DomainNameInfo' resource.", "READ.iam.DomainNameInfo": "Read a 'iam.DomainNameInfo' resource.", "UPDATE.iam.DomainNameInfo": "Update a 'iam.DomainNameInfo' resource.", "READ.iam.EndPointPrivilege": "Read a 'iam.EndPointPrivilege' resource.", "READ.iam.EndPointRole": "Read a 'iam.EndPointRole' resource.", "CREATE.iam.EndPointUser": "Create a 'iam.EndPointUser' resource.", "DELETE.iam.EndPointUser": "Delete a 'iam.EndPointUser' resource.", "READ.iam.EndPointUser": "Read a 'iam.EndPointUser' resource.", "UPDATE.iam.EndPointUser": "Update a 'iam.EndPointUser' resource.", "READ.iam.EndPointUserInventory": "Read a 'iam.EndPointUserInventory' resource.", "CREATE.iam.EndPointUserPolicy": "Create a 'iam.EndPointUserPolicy' resource.", "DELETE.iam.EndPointUserPolicy": "Delete a 'iam.EndPointUserPolicy' resource.", "READ.iam.EndPointUserPolicy": "Read a 'iam.EndPointUserPolicy' resource.", "UPDATE.iam.EndPointUserPolicy": "Update a 'iam.EndPointUserPolicy' resource.", "READ.iam.EndPointUserPolicyInventory": "Read a 'iam.EndPointUserPolicyInventory' resource.", "CREATE.iam.EndPointUserRole": "Create a 'iam.EndPointUserRole' resource.", "DELETE.iam.EndPointUserRole": "Delete a 'iam.EndPointUserRole' resource.", "READ.iam.EndPointUserRole": "Read a 'iam.EndPointUserRole' resource.", "UPDATE.iam.EndPointUserRole": "Update a 'iam.EndPointUserRole' resource.", "READ.iam.EndPointUserRoleInventory": "Read a 'iam.EndPointUserRoleInventory' resource.", "CREATE.iam.GuestAccessSettings": "Create a 'iam.GuestAccessSettings' resource.", "DELETE.iam.GuestAccessSettings": "Delete a 'iam.GuestAccessSettings' resource.", "READ.iam.GuestAccessSettings": "Read a 'iam.GuestAccessSettings' resource.", "UPDATE.iam.GuestAccessSettings": "Update a 'iam.GuestAccessSettings' resource.", "CREATE.iam.Idp": "Create a 'iam.Idp' resource.", "DELETE.iam.Idp": "Delete a 'iam.Idp' resource.", "READ.iam.Idp": "Read a 'iam.Idp' resource.", "UPDATE.iam.Idp": "Update a 'iam.Idp' resource.", "READ.iam.IdpReference": "Read a 'iam.IdpReference' resource.", "UPDATE.iam.IdpReference": "Update a 'iam.IdpReference' resource.", "CREATE.iam.IpAccessManagement": "Create a 'iam.IpAccessManagement' resource.", "READ.iam.IpAccessManagement": "Read a 'iam.IpAccessManagement' resource.", "UPDATE.iam.IpAccessManagement": "Update a 'iam.IpAccessManagement' resource.", "CREATE.iam.IpAddress": "Create a 'iam.IpAddress' resource.", "DELETE.iam.IpAddress": "Delete a 'iam.IpAddress' resource.", "READ.iam.IpAddress": "Read a 'iam.IpAddress' resource.", "UPDATE.iam.IpAddress": "Update a 'iam.IpAddress' resource.", "READ.iam.LdapConfigParams": "Read a 'iam.LdapConfigParams' resource.", "CREATE.iam.LdapGroup": "Create a 'iam.LdapGroup' resource.", "DELETE.iam.LdapGroup": "Delete a 'iam.LdapGroup' resource.", "READ.iam.LdapGroup": "Read a 'iam.LdapGroup' resource.", "UPDATE.iam.LdapGroup": "Update a 'iam.LdapGroup' resource.", "READ.iam.LdapGroupInventory": "Read a 'iam.LdapGroupInventory' resource.", "READ.iam.LdapMeta": "Read a 'iam.LdapMeta' resource.", "CREATE.iam.LdapPolicy": "Create a 'iam.LdapPolicy' resource.", "DELETE.iam.LdapPolicy": "Delete a 'iam.LdapPolicy' resource.", "READ.iam.LdapPolicy": "Read a 'iam.LdapPolicy' resource.", "UPDATE.iam.LdapPolicy": "Update a 'iam.LdapPolicy' resource.", "READ.iam.LdapPolicyInventory": "Read a 'iam.LdapPolicyInventory' resource.", "CREATE.iam.LdapProvider": "Create a 'iam.LdapProvider' resource.", "DELETE.iam.LdapProvider": "Delete a 'iam.LdapProvider' resource.", "READ.iam.LdapProvider": "Read a 'iam.LdapProvider' resource.", "UPDATE.iam.LdapProvider": "Update a 'iam.LdapProvider' resource.", "READ.iam.LdapProviderInventory": "Read a 'iam.LdapProviderInventory' resource.", "CREATE.iam.LocalUserPassword": "Create a 'iam.LocalUserPassword' resource.", "READ.iam.LocalUserPassword": "Read a 'iam.LocalUserPassword' resource.", "UPDATE.iam.LocalUserPassword": "Update a 'iam.LocalUserPassword' resource.", "READ.iam.LocalUserPasswordPolicy": "Read a 'iam.LocalUserPasswordPolicy' resource.", "UPDATE.iam.LocalUserPasswordPolicy": "Update a 'iam.LocalUserPasswordPolicy' resource.", "DELETE.iam.OAuthToken": "Delete a 'iam.OAuthToken' resource.", "READ.iam.OAuthToken": "Read a 'iam.OAuthToken' resource.", "READ.iam.PasswordHistorySettingCollection": "Read a 'iam.PasswordHistorySettingCollection' resource.", "CREATE.iam.Permission": "Create a 'iam.Permission' resource.", "DELETE.iam.Permission": "Delete a 'iam.Permission' resource.", "READ.iam.Permission": "Read a 'iam.Permission' resource.", "UPDATE.iam.Permission": "Update a 'iam.Permission' resource.", "CREATE.iam.PrivateKeySpec": "Create a 'iam.PrivateKeySpec' resource.", "DELETE.iam.PrivateKeySpec": "Delete a 'iam.PrivateKeySpec' resource.", "READ.iam.PrivateKeySpec": "Read a 'iam.PrivateKeySpec' resource.", "UPDATE.iam.PrivateKeySpec": "Update a 'iam.PrivateKeySpec' resource.", "READ.iam.Privilege": "Read a 'iam.Privilege' resource.", "CREATE.iam.PrivilegeSet": "Create a 'iam.PrivilegeSet' resource.", "DELETE.iam.PrivilegeSet": "Delete a 'iam.PrivilegeSet' resource.", "READ.iam.PrivilegeSet": "Read a 'iam.PrivilegeSet' resource.", "UPDATE.iam.PrivilegeSet": "Update a 'iam.PrivilegeSet' resource.", "CREATE.iam.PrivilegeSetMetaInfo": "Create a 'iam.PrivilegeSetMetaInfo' resource.", "READ.iam.PrivilegeSetMetaInfo": "Read a 'iam.PrivilegeSetMetaInfo' resource.", "CREATE.iam.Qualifier": "Create a 'iam.Qualifier' resource.", "DELETE.iam.Qualifier": "Delete a 'iam.Qualifier' resource.", "READ.iam.Qualifier": "Read a 'iam.Qualifier' resource.", "UPDATE.iam.Qualifier": "Update a 'iam.Qualifier' resource.", "READ.iam.ResourceLimits": "Read a 'iam.ResourceLimits' resource.", "UPDATE.iam.ResourceLimits": "Update a 'iam.ResourceLimits' resource.", "READ.iam.ResourcePermission": "Read a 'iam.ResourcePermission' resource.", "CREATE.iam.ResourceRoles": "Create a 'iam.ResourceRoles' resource.", "DELETE.iam.ResourceRoles": "Delete a 'iam.ResourceRoles' resource.", "READ.iam.ResourceRoles": "Read a 'iam.ResourceRoles' resource.", "UPDATE.iam.ResourceRoles": "Update a 'iam.ResourceRoles' resource.", "READ.iam.Role": "Read a 'iam.Role' resource.", "READ.iam.SecurityHolder": "Read a 'iam.SecurityHolder' resource.", "READ.iam.ServiceProvider": "Read a 'iam.ServiceProvider' resource.", "DELETE.iam.Session": "Delete a 'iam.Session' resource.", "READ.iam.Session": "Read a 'iam.Session' resource.", "CREATE.iam.SessionLimits": "Create a 'iam.SessionLimits' resource.", "DELETE.iam.SessionLimits": "Delete a 'iam.SessionLimits' resource.", "READ.iam.SessionLimits": "Read a 'iam.SessionLimits' resource.", "UPDATE.iam.SessionLimits": "Update a 'iam.SessionLimits' resource.", "CREATE.iam.SharingRule": "Create a 'iam.SharingRule' resource.", "DELETE.iam.SharingRule": "Delete a 'iam.SharingRule' resource.", "READ.iam.SharingRule": "Read a 'iam.SharingRule' resource.", "UPDATE.iam.SharingRule": "Update a 'iam.SharingRule' resource.", "READ.iam.System": "Read a 'iam.System' resource.", "READ.iam.TestIdpConfiguration": "Read a 'iam.TestIdpConfiguration' resource.", "UPDATE.iam.TestIdpConfiguration": "Update a 'iam.TestIdpConfiguration' resource.", "CREATE.iam.TrustPoint": "Create a 'iam.TrustPoint' resource.", "DELETE.iam.TrustPoint": "Delete a 'iam.TrustPoint' resource.", "READ.iam.TrustPoint": "Read a 'iam.TrustPoint' resource.", "CREATE.iam.User": "Create a 'iam.User' resource.", "DELETE.iam.User": "Delete a 'iam.User' resource.", "READ.iam.User": "Read a 'iam.User' resource.", "UPDATE.iam.User": "Update a 'iam.User' resource.", "CREATE.iam.UserGroup": "Create a 'iam.UserGroup' resource.", "DELETE.iam.UserGroup": "Delete a 'iam.UserGroup' resource.", "READ.iam.UserGroup": "Read a 'iam.UserGroup' resource.", "UPDATE.iam.UserGroup": "Update a 'iam.UserGroup' resource.", "READ.iam.UserPreference": "Read a 'iam.UserPreference' resource.", "UPDATE.iam.UserPreference": "Update a 'iam.UserPreference' resource.", "CREATE.iam.UserQualifier": "Create a 'iam.UserQualifier' resource.", "DELETE.iam.UserQualifier": "Delete a 'iam.UserQualifier' resource.", "READ.iam.UserQualifier": "Read a 'iam.UserQualifier' resource.", "UPDATE.iam.UserQualifier": "Update a 'iam.UserQualifier' resource.", "CREATE.iam.UserSetting": "Create a 'iam.UserSetting' resource.", "READ.iam.UserSetting": "Read a 'iam.UserSetting' resource.", "UPDATE.iam.UserSetting": "Update a 'iam.UserSetting' resource.", "READ.inventory.DeviceInfo": "Read a 'inventory.DeviceInfo' resource.", "READ.inventory.DnMoBinding": "Read a 'inventory.DnMoBinding' resource.", "READ.inventory.GenericInventory": "Read a 'inventory.GenericInventory' resource.", "UPDATE.inventory.GenericInventory": "Update a 'inventory.GenericInventory' resource.", "READ.inventory.GenericInventoryHolder": "Read a 'inventory.GenericInventoryHolder' resource.", "UPDATE.inventory.GenericInventoryHolder": "Update a 'inventory.GenericInventoryHolder' resource.", "CREATE.inventory.Request": "Create a 'inventory.Request' resource.", "CREATE.ipmioverlan.Policy": "Create a 'ipmioverlan.Policy' resource.", "DELETE.ipmioverlan.Policy": "Delete a 'ipmioverlan.Policy' resource.", "READ.ipmioverlan.Policy": "Read a 'ipmioverlan.Policy' resource.", "UPDATE.ipmioverlan.Policy": "Update a 'ipmioverlan.Policy' resource.", "READ.ipmioverlan.PolicyInventory": "Read a 'ipmioverlan.PolicyInventory' resource.", "READ.ippool.BlockLease": "Read a 'ippool.BlockLease' resource.", "DELETE.ippool.IpLease": "Delete a 'ippool.IpLease' resource.", "READ.ippool.IpLease": "Read a 'ippool.IpLease' resource.", "CREATE.ippool.Pool": "Create a 'ippool.Pool' resource.", "DELETE.ippool.Pool": "Delete a 'ippool.Pool' resource.", "READ.ippool.Pool": "Read a 'ippool.Pool' resource.", "UPDATE.ippool.Pool": "Update a 'ippool.Pool' resource.", "READ.ippool.PoolMember": "Read a 'ippool.PoolMember' resource.", "CREATE.ippool.Reservation": "Create a 'ippool.Reservation' resource.", "DELETE.ippool.Reservation": "Delete a 'ippool.Reservation' resource.", "READ.ippool.Reservation": "Read a 'ippool.Reservation' resource.", "UPDATE.ippool.Reservation": "Update a 'ippool.Reservation' resource.", "READ.ippool.ShadowBlock": "Read a 'ippool.ShadowBlock' resource.", "READ.ippool.ShadowPool": "Read a 'ippool.ShadowPool' resource.", "READ.ippool.Universe": "Read a 'ippool.Universe' resource.", "READ.iqnpool.Block": "Read a 'iqnpool.Block' resource.", "DELETE.iqnpool.Lease": "Delete a 'iqnpool.Lease' resource.", "READ.iqnpool.Lease": "Read a 'iqnpool.Lease' resource.", "CREATE.iqnpool.Pool": "Create a 'iqnpool.Pool' resource.", "DELETE.iqnpool.Pool": "Delete a 'iqnpool.Pool' resource.", "READ.iqnpool.Pool": "Read a 'iqnpool.Pool' resource.", "UPDATE.iqnpool.Pool": "Update a 'iqnpool.Pool' resource.", "READ.iqnpool.PoolMember": "Read a 'iqnpool.PoolMember' resource.", "CREATE.iqnpool.Reservation": "Create a 'iqnpool.Reservation' resource.", "DELETE.iqnpool.Reservation": "Delete a 'iqnpool.Reservation' resource.", "READ.iqnpool.Reservation": "Read a 'iqnpool.Reservation' resource.", "READ.iqnpool.Universe": "Read a 'iqnpool.Universe' resource.", "READ.iwotenant.MaintenanceNotification": "Read a 'iwotenant.MaintenanceNotification' resource.", "CREATE.iwotenant.Migrate": "Create a 'iwotenant.Migrate' resource.", "READ.iwotenant.Migrate": "Read a 'iwotenant.Migrate' resource.", "UPDATE.iwotenant.Migrate": "Update a 'iwotenant.Migrate' resource.", "CREATE.iwotenant.TenantCustomization": "Create a 'iwotenant.TenantCustomization' resource.", "DELETE.iwotenant.TenantCustomization": "Delete a 'iwotenant.TenantCustomization' resource.", "READ.iwotenant.TenantCustomization": "Read a 'iwotenant.TenantCustomization' resource.", "UPDATE.iwotenant.TenantCustomization": "Update a 'iwotenant.TenantCustomization' resource.", "READ.iwotenant.TenantStatus": "Read a 'iwotenant.TenantStatus' resource.", "CREATE.kvm.Policy": "Create a 'kvm.Policy' resource.", "DELETE.kvm.Policy": "Delete a 'kvm.Policy' resource.", "READ.kvm.Policy": "Read a 'kvm.Policy' resource.", "UPDATE.kvm.Policy": "Update a 'kvm.Policy' resource.", "READ.kvm.PolicyInventory": "Read a 'kvm.PolicyInventory' resource.", "CREATE.kvm.Session": "Create a 'kvm.Session' resource.", "READ.kvm.Session": "Read a 'kvm.Session' resource.", "UPDATE.kvm.Session": "Update a 'kvm.Session' resource.", "CREATE.kvm.Tunnel": "Create a 'kvm.Tunnel' resource.", "READ.kvm.Tunnel": "Read a 'kvm.Tunnel' resource.", "CREATE.kvm.TunneledKvmPolicy": "Create a 'kvm.TunneledKvmPolicy' resource.", "DELETE.kvm.TunneledKvmPolicy": "Delete a 'kvm.TunneledKvmPolicy' resource.", "READ.kvm.TunneledKvmPolicy": "Read a 'kvm.TunneledKvmPolicy' resource.", "UPDATE.kvm.TunneledKvmPolicy": "Update a 'kvm.TunneledKvmPolicy' resource.", "READ.license.AccountLicenseData": "Read a 'license.AccountLicenseData' resource.", "UPDATE.license.AccountLicenseData": "Update a 'license.AccountLicenseData' resource.", "READ.license.CustomerOp": "Read a 'license.CustomerOp' resource.", "UPDATE.license.CustomerOp": "Update a 'license.CustomerOp' resource.", "READ.license.ErpCustomerOp": "Read a 'license.ErpCustomerOp' resource.", "UPDATE.license.ErpCustomerOp": "Update a 'license.ErpCustomerOp' resource.", "CREATE.license.ErpLicenseCount": "Create a 'license.ErpLicenseCount' resource.", "READ.license.ErpLicenseCount": "Read a 'license.ErpLicenseCount' resource.", "READ.license.IksCustomerOp": "Read a 'license.IksCustomerOp' resource.", "UPDATE.license.IksCustomerOp": "Update a 'license.IksCustomerOp' resource.", "CREATE.license.IksLicenseCount": "Create a 'license.IksLicenseCount' resource.", "READ.license.IksLicenseCount": "Read a 'license.IksLicenseCount' resource.", "UPDATE.license.IksLicenseCount": "Update a 'license.IksLicenseCount' resource.", "READ.license.IncCustomerOp": "Read a 'license.IncCustomerOp' resource.", "UPDATE.license.IncCustomerOp": "Update a 'license.IncCustomerOp' resource.", "CREATE.license.IncLicenseCount": "Create a 'license.IncLicenseCount' resource.", "READ.license.IncLicenseCount": "Read a 'license.IncLicenseCount' resource.", "UPDATE.license.IncLicenseCount": "Update a 'license.IncLicenseCount' resource.", "READ.license.IwoCustomerOp": "Read a 'license.IwoCustomerOp' resource.", "UPDATE.license.IwoCustomerOp": "Update a 'license.IwoCustomerOp' resource.", "CREATE.license.IwoLicenseCount": "Create a 'license.IwoLicenseCount' resource.", "READ.license.IwoLicenseCount": "Read a 'license.IwoLicenseCount' resource.", "UPDATE.license.IwoLicenseCount": "Update a 'license.IwoLicenseCount' resource.", "CREATE.license.LicenseInfo": "Create a 'license.LicenseInfo' resource.", "READ.license.LicenseInfo": "Read a 'license.LicenseInfo' resource.", "UPDATE.license.LicenseInfo": "Update a 'license.LicenseInfo' resource.", "READ.license.LicenseInfoView": "Read a 'license.LicenseInfoView' resource.", "READ.license.LicenseRegistrationStatus": "Read a 'license.LicenseRegistrationStatus' resource.", "UPDATE.license.LicenseRegistrationStatus": "Update a 'license.LicenseRegistrationStatus' resource.", "CREATE.license.LicenseReservationOp": "Create a 'license.LicenseReservationOp' resource.", "READ.license.LicenseReservationOp": "Read a 'license.LicenseReservationOp' resource.", "UPDATE.license.LicenseReservationOp": "Update a 'license.LicenseReservationOp' resource.", "READ.license.SmartlicenseToken": "Read a 'license.SmartlicenseToken' resource.", "UPDATE.license.SmartlicenseToken": "Update a 'license.SmartlicenseToken' resource.", "READ.ls.ServiceProfile": "Read a 'ls.ServiceProfile' resource.", "UPDATE.ls.ServiceProfile": "Update a 'ls.ServiceProfile' resource.", "READ.macpool.IdBlock": "Read a 'macpool.IdBlock' resource.", "DELETE.macpool.Lease": "Delete a 'macpool.Lease' resource.", "READ.macpool.Lease": "Read a 'macpool.Lease' resource.", "CREATE.macpool.Pool": "Create a 'macpool.Pool' resource.", "DELETE.macpool.Pool": "Delete a 'macpool.Pool' resource.", "READ.macpool.Pool": "Read a 'macpool.Pool' resource.", "UPDATE.macpool.Pool": "Update a 'macpool.Pool' resource.", "READ.macpool.PoolMember": "Read a 'macpool.PoolMember' resource.", "CREATE.macpool.Reservation": "Create a 'macpool.Reservation' resource.", "DELETE.macpool.Reservation": "Delete a 'macpool.Reservation' resource.", "READ.macpool.Reservation": "Read a 'macpool.Reservation' resource.", "UPDATE.macpool.Reservation": "Update a 'macpool.Reservation' resource.", "READ.macpool.Universe": "Read a 'macpool.Universe' resource.", "READ.management.Controller": "Read a 'management.Controller' resource.", "UPDATE.management.Controller": "Update a 'management.Controller' resource.", "READ.management.Entity": "Read a 'management.Entity' resource.", "UPDATE.management.Entity": "Update a 'management.Entity' resource.", "READ.management.Interface": "Read a 'management.Interface' resource.", "UPDATE.management.Interface": "Update a 'management.Interface' resource.", "READ.memory.Array": "Read a 'memory.Array' resource.", "UPDATE.memory.Array": "Update a 'memory.Array' resource.", "READ.memory.PersistentMemoryConfigResult": "Read a 'memory.PersistentMemoryConfigResult' resource.", "UPDATE.memory.PersistentMemoryConfigResult": "Update a 'memory.PersistentMemoryConfigResult' resource.", "READ.memory.PersistentMemoryConfiguration": "Read a 'memory.PersistentMemoryConfiguration' resource.", "UPDATE.memory.PersistentMemoryConfiguration": "Update a 'memory.PersistentMemoryConfiguration' resource.", "READ.memory.PersistentMemoryNamespace": "Read a 'memory.PersistentMemoryNamespace' resource.", "UPDATE.memory.PersistentMemoryNamespace": "Update a 'memory.PersistentMemoryNamespace' resource.", "READ.memory.PersistentMemoryNamespaceConfigResult": "Read a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "UPDATE.memory.PersistentMemoryNamespaceConfigResult": "Update a 'memory.PersistentMemoryNamespaceConfigResult' resource.", "CREATE.memory.PersistentMemoryPolicy": "Create a 'memory.PersistentMemoryPolicy' resource.", "DELETE.memory.PersistentMemoryPolicy": "Delete a 'memory.PersistentMemoryPolicy' resource.", "READ.memory.PersistentMemoryPolicy": "Read a 'memory.PersistentMemoryPolicy' resource.", "UPDATE.memory.PersistentMemoryPolicy": "Update a 'memory.PersistentMemoryPolicy' resource.", "READ.memory.PersistentMemoryRegion": "Read a 'memory.PersistentMemoryRegion' resource.", "UPDATE.memory.PersistentMemoryRegion": "Update a 'memory.PersistentMemoryRegion' resource.", "READ.memory.PersistentMemoryUnit": "Read a 'memory.PersistentMemoryUnit' resource.", "UPDATE.memory.PersistentMemoryUnit": "Update a 'memory.PersistentMemoryUnit' resource.", "CREATE.memory.Policy": "Create a 'memory.Policy' resource.", "DELETE.memory.Policy": "Delete a 'memory.Policy' resource.", "READ.memory.Policy": "Read a 'memory.Policy' resource.", "UPDATE.memory.Policy": "Update a 'memory.Policy' resource.", "READ.memory.PolicyInventory": "Read a 'memory.PolicyInventory' resource.", "READ.memory.Unit": "Read a 'memory.Unit' resource.", "UPDATE.memory.Unit": "Update a 'memory.Unit' resource.", "READ.meraki.Device": "Read a 'meraki.Device' resource.", "READ.meraki.Network": "Read a 'meraki.Network' resource.", "READ.meraki.Organization": "Read a 'meraki.Organization' resource.", "READ.meraki.PortProfile": "Read a 'meraki.PortProfile' resource.", "READ.meraki.Tag": "Read a 'meraki.Tag' resource.", "READ.meta.Definition": "Read a 'meta.Definition' resource.", "READ.metrics.Configuration": "Read a 'metrics.Configuration' resource.", "UPDATE.metrics.Configuration": "Update a 'metrics.Configuration' resource.", "CREATE.metrics.MetricsExploration": "Create a 'metrics.MetricsExploration' resource.", "DELETE.metrics.MetricsExploration": "Delete a 'metrics.MetricsExploration' resource.", "READ.metrics.MetricsExploration": "Read a 'metrics.MetricsExploration' resource.", "UPDATE.metrics.MetricsExploration": "Update a 'metrics.MetricsExploration' resource.", "CREATE.metrics.ResourceConfiguration": "Create a 'metrics.ResourceConfiguration' resource.", "READ.metrics.ResourceConfiguration": "Read a 'metrics.ResourceConfiguration' resource.", "UPDATE.metrics.ResourceConfiguration": "Update a 'metrics.ResourceConfiguration' resource.", "READ.mgmt.BackupCategory": "Read a 'mgmt.BackupCategory' resource.", "CREATE.mgmt.ConfigBackupFile": "Create a 'mgmt.ConfigBackupFile' resource.", "DELETE.mgmt.ConfigBackupFile": "Delete a 'mgmt.ConfigBackupFile' resource.", "READ.mgmt.ConfigBackupFile": "Read a 'mgmt.ConfigBackupFile' resource.", "UPDATE.mgmt.ConfigBackupFile": "Update a 'mgmt.ConfigBackupFile' resource.", "DELETE.mgmt.ConfigBackupInstance": "Delete a 'mgmt.ConfigBackupInstance' resource.", "READ.mgmt.ConfigBackupInstance": "Read a 'mgmt.ConfigBackupInstance' resource.", "UPDATE.mgmt.ConfigBackupInstance": "Update a 'mgmt.ConfigBackupInstance' resource.", "CREATE.mgmt.ConfigBackupOperation": "Create a 'mgmt.ConfigBackupOperation' resource.", "DELETE.mgmt.ConfigBackupOperation": "Delete a 'mgmt.ConfigBackupOperation' resource.", "READ.mgmt.ConfigBackupOperation": "Read a 'mgmt.ConfigBackupOperation' resource.", "UPDATE.mgmt.ConfigBackupOperation": "Update a 'mgmt.ConfigBackupOperation' resource.", "READ.mgmt.ConfigCategorySummary": "Read a 'mgmt.ConfigCategorySummary' resource.", "CREATE.mgmt.ConfigOperationSetting": "Create a 'mgmt.ConfigOperationSetting' resource.", "DELETE.mgmt.ConfigOperationSetting": "Delete a 'mgmt.ConfigOperationSetting' resource.", "READ.mgmt.ConfigOperationSetting": "Read a 'mgmt.ConfigOperationSetting' resource.", "UPDATE.mgmt.ConfigOperationSetting": "Update a 'mgmt.ConfigOperationSetting' resource.", "READ.mgmt.ConfigRestoreCategorySummary": "Read a 'mgmt.ConfigRestoreCategorySummary' resource.", "CREATE.mgmt.ConfigRestoreOperation": "Create a 'mgmt.ConfigRestoreOperation' resource.", "DELETE.mgmt.ConfigRestoreOperation": "Delete a 'mgmt.ConfigRestoreOperation' resource.", "READ.mgmt.ConfigRestoreOperation": "Read a 'mgmt.ConfigRestoreOperation' resource.", "READ.mgmt.ObjectBackupMeta": "Read a 'mgmt.ObjectBackupMeta' resource.", "READ.mgmt.OrgBackupOperation": "Read a 'mgmt.OrgBackupOperation' resource.", "READ.mgmt.OrgRestoreOperation": "Read a 'mgmt.OrgRestoreOperation' resource.", "READ.monitoring.HealthStatus": "Read a 'monitoring.HealthStatus' resource.", "READ.network.DiscoveredNeighbor": "Read a 'network.DiscoveredNeighbor' resource.", "READ.network.Dns": "Read a 'network.Dns' resource.", "READ.network.Element": "Read a 'network.Element' resource.", "UPDATE.network.Element": "Update a 'network.Element' resource.", "READ.network.ElementSummary": "Read a 'network.ElementSummary' resource.", "READ.network.FcZoneInfo": "Read a 'network.FcZoneInfo' resource.", "UPDATE.network.FcZoneInfo": "Update a 'network.FcZoneInfo' resource.", "READ.network.FeatureControl": "Read a 'network.FeatureControl' resource.", "READ.network.InterfaceList": "Read a 'network.InterfaceList' resource.", "READ.network.LicenseFile": "Read a 'network.LicenseFile' resource.", "READ.network.SecureRouter": "Read a 'network.SecureRouter' resource.", "UPDATE.network.SecureRouter": "Update a 'network.SecureRouter' resource.", "READ.network.SecureRouterSetting": "Read a 'network.SecureRouterSetting' resource.", "UPDATE.network.SecureRouterSetting": "Update a 'network.SecureRouterSetting' resource.", "READ.network.SupervisorCard": "Read a 'network.SupervisorCard' resource.", "READ.network.TelemetryCheck": "Read a 'network.TelemetryCheck' resource.", "READ.network.Vethernet": "Read a 'network.Vethernet' resource.", "UPDATE.network.Vethernet": "Update a 'network.Vethernet' resource.", "READ.network.Vfc": "Read a 'network.Vfc' resource.", "UPDATE.network.Vfc": "Update a 'network.Vfc' resource.", "READ.network.VlanPortInfo": "Read a 'network.VlanPortInfo' resource.", "UPDATE.network.VlanPortInfo": "Update a 'network.VlanPortInfo' resource.", "READ.network.VpcDomain": "Read a 'network.VpcDomain' resource.", "READ.network.VpcMember": "Read a 'network.VpcMember' resource.", "READ.network.VpcPeer": "Read a 'network.VpcPeer' resource.", "READ.network.Vrf": "Read a 'network.Vrf' resource.", "CREATE.networkconfig.Policy": "Create a 'networkconfig.Policy' resource.", "DELETE.networkconfig.Policy": "Delete a 'networkconfig.Policy' resource.", "READ.networkconfig.Policy": "Read a 'networkconfig.Policy' resource.", "UPDATE.networkconfig.Policy": "Update a 'networkconfig.Policy' resource.", "READ.networkconfig.PolicyInventory": "Read a 'networkconfig.PolicyInventory' resource.", "READ.niaapi.ApicCcoPost": "Read a 'niaapi.ApicCcoPost' resource.", "READ.niaapi.ApicFieldNotice": "Read a 'niaapi.ApicFieldNotice' resource.", "READ.niaapi.ApicHweol": "Read a 'niaapi.ApicHweol' resource.", "READ.niaapi.ApicLatestMaintainedRelease": "Read a 'niaapi.ApicLatestMaintainedRelease' resource.", "READ.niaapi.ApicReleaseRecommend": "Read a 'niaapi.ApicReleaseRecommend' resource.", "READ.niaapi.ApicSweol": "Read a 'niaapi.ApicSweol' resource.", "READ.niaapi.DcnmCcoPost": "Read a 'niaapi.DcnmCcoPost' resource.", "READ.niaapi.DcnmFieldNotice": "Read a 'niaapi.DcnmFieldNotice' resource.", "READ.niaapi.DcnmHweol": "Read a 'niaapi.DcnmHweol' resource.", "READ.niaapi.DcnmLatestMaintainedRelease": "Read a 'niaapi.DcnmLatestMaintainedRelease' resource.", "READ.niaapi.DcnmReleaseRecommend": "Read a 'niaapi.DcnmReleaseRecommend' resource.", "READ.niaapi.DcnmSweol": "Read a 'niaapi.DcnmSweol' resource.", "READ.niaapi.FileDownloader": "Read a 'niaapi.FileDownloader' resource.", "READ.niaapi.NdEncryptedFileDownload": "Read a 'niaapi.NdEncryptedFileDownload' resource.", "READ.niaapi.NdMetadata": "Read a 'niaapi.NdMetadata' resource.", "READ.niaapi.NdMetadataFileDownloader": "Read a 'niaapi.NdMetadataFileDownloader' resource.", "READ.niaapi.NdMetadataSoftwareDownload": "Read a 'niaapi.NdMetadataSoftwareDownload' resource.", "READ.niaapi.NiaMetadata": "Read a 'niaapi.NiaMetadata' resource.", "READ.niaapi.NibFileDownloader": "Read a 'niaapi.NibFileDownloader' resource.", "READ.niaapi.NibMetadata": "Read a 'niaapi.NibMetadata' resource.", "READ.niaapi.PuvScriptDownloader": "Read a 'niaapi.PuvScriptDownloader' resource.", "READ.niaapi.SnValidatorMetadata": "Read a 'niaapi.SnValidatorMetadata' resource.", "READ.niaapi.UpgradeAssistFile": "Read a 'niaapi.UpgradeAssistFile' resource.", "READ.niaapi.VersionRegex": "Read a 'niaapi.VersionRegex' resource.", "READ.niatelemetry.AaaLdapProviderDetails": "Read a 'niatelemetry.AaaLdapProviderDetails' resource.", "READ.niatelemetry.AaaRadiusProviderDetails": "Read a 'niatelemetry.AaaRadiusProviderDetails' resource.", "READ.niatelemetry.AaaTacacsProviderDetails": "Read a 'niatelemetry.AaaTacacsProviderDetails' resource.", "READ.niatelemetry.Anomaly": "Read a 'niatelemetry.Anomaly' resource.", "READ.niatelemetry.ApicAppPluginDetails": "Read a 'niatelemetry.ApicAppPluginDetails' resource.", "READ.niatelemetry.ApicCoreFileDetails": "Read a 'niatelemetry.ApicCoreFileDetails' resource.", "READ.niatelemetry.ApicDbgexpRsExportDest": "Read a 'niatelemetry.ApicDbgexpRsExportDest' resource.", "READ.niatelemetry.ApicDbgexpRsTsScheduler": "Read a 'niatelemetry.ApicDbgexpRsTsScheduler' resource.", "READ.niatelemetry.ApicFanDetails": "Read a 'niatelemetry.ApicFanDetails' resource.", "READ.niatelemetry.ApicFexDetails": "Read a 'niatelemetry.ApicFexDetails' resource.", "READ.niatelemetry.ApicFlashDetails": "Read a 'niatelemetry.ApicFlashDetails' resource.", "READ.niatelemetry.ApicNtpAuth": "Read a 'niatelemetry.ApicNtpAuth' resource.", "READ.niatelemetry.ApicPerformanceData": "Read a 'niatelemetry.ApicPerformanceData' resource.", "READ.niatelemetry.ApicPodData": "Read a 'niatelemetry.ApicPodData' resource.", "READ.niatelemetry.ApicPsuDetails": "Read a 'niatelemetry.ApicPsuDetails' resource.", "READ.niatelemetry.ApicRealmDetails": "Read a 'niatelemetry.ApicRealmDetails' resource.", "READ.niatelemetry.ApicSnmpClientGrpDetails": "Read a 'niatelemetry.ApicSnmpClientGrpDetails' resource.", "READ.niatelemetry.ApicSnmpCommunityAccessDetails": "Read a 'niatelemetry.ApicSnmpCommunityAccessDetails' resource.", "READ.niatelemetry.ApicSnmpCommunityDetails": "Read a 'niatelemetry.ApicSnmpCommunityDetails' resource.", "READ.niatelemetry.ApicSnmpTrapDetails": "Read a 'niatelemetry.ApicSnmpTrapDetails' resource.", "READ.niatelemetry.ApicSnmpTrapFwdServerDetails": "Read a 'niatelemetry.ApicSnmpTrapFwdServerDetails' resource.", "READ.niatelemetry.ApicSnmpVersionThreeDetails": "Read a 'niatelemetry.ApicSnmpVersionThreeDetails' resource.", "READ.niatelemetry.ApicSysLogGrp": "Read a 'niatelemetry.ApicSysLogGrp' resource.", "READ.niatelemetry.ApicSysLogSrc": "Read a 'niatelemetry.ApicSysLogSrc' resource.", "READ.niatelemetry.ApicTransceiverDetails": "Read a 'niatelemetry.ApicTransceiverDetails' resource.", "READ.niatelemetry.ApicUiPageCounts": "Read a 'niatelemetry.ApicUiPageCounts' resource.", "READ.niatelemetry.ApicVision": "Read a 'niatelemetry.ApicVision' resource.", "READ.niatelemetry.AppDetails": "Read a 'niatelemetry.AppDetails' resource.", "READ.niatelemetry.CloudDetails": "Read a 'niatelemetry.CloudDetails' resource.", "READ.niatelemetry.Cluster": "Read a 'niatelemetry.Cluster' resource.", "READ.niatelemetry.ClusterNode": "Read a 'niatelemetry.ClusterNode' resource.", "READ.niatelemetry.CommonPolicies": "Read a 'niatelemetry.CommonPolicies' resource.", "READ.niatelemetry.Controller": "Read a 'niatelemetry.Controller' resource.", "READ.niatelemetry.DcnmFanDetails": "Read a 'niatelemetry.DcnmFanDetails' resource.", "READ.niatelemetry.DcnmFexDetails": "Read a 'niatelemetry.DcnmFexDetails' resource.", "READ.niatelemetry.DcnmModuleDetails": "Read a 'niatelemetry.DcnmModuleDetails' resource.", "READ.niatelemetry.DcnmPsuDetails": "Read a 'niatelemetry.DcnmPsuDetails' resource.", "READ.niatelemetry.DcnmTransceiverDetails": "Read a 'niatelemetry.DcnmTransceiverDetails' resource.", "READ.niatelemetry.DomInfoObject": "Read a 'niatelemetry.DomInfoObject' resource.", "READ.niatelemetry.DomThresInfoObject": "Read a 'niatelemetry.DomThresInfoObject' resource.", "READ.niatelemetry.Epg": "Read a 'niatelemetry.Epg' resource.", "READ.niatelemetry.Fabric": "Read a 'niatelemetry.Fabric' resource.", "READ.niatelemetry.FabricModuleDetails": "Read a 'niatelemetry.FabricModuleDetails' resource.", "READ.niatelemetry.FabricNodeControlDetails": "Read a 'niatelemetry.FabricNodeControlDetails' resource.", "READ.niatelemetry.FabricPodProfile": "Read a 'niatelemetry.FabricPodProfile' resource.", "READ.niatelemetry.FabricPodSs": "Read a 'niatelemetry.FabricPodSs' resource.", "READ.niatelemetry.Fault": "Read a 'niatelemetry.Fault' resource.", "READ.niatelemetry.HcloudDetails": "Read a 'niatelemetry.HcloudDetails' resource.", "READ.niatelemetry.HealthInsightsData": "Read a 'niatelemetry.HealthInsightsData' resource.", "READ.niatelemetry.HttpsAclContractDetails": "Read a 'niatelemetry.HttpsAclContractDetails' resource.", "READ.niatelemetry.HttpsAclContractFilterMap": "Read a 'niatelemetry.HttpsAclContractFilterMap' resource.", "READ.niatelemetry.HttpsAclEpgContractMap": "Read a 'niatelemetry.HttpsAclEpgContractMap' resource.", "READ.niatelemetry.HttpsAclEpgDetails": "Read a 'niatelemetry.HttpsAclEpgDetails' resource.", "READ.niatelemetry.HttpsAclFilterDetails": "Read a 'niatelemetry.HttpsAclFilterDetails' resource.", "READ.niatelemetry.InsightGroupDetails": "Read a 'niatelemetry.InsightGroupDetails' resource.", "READ.niatelemetry.Lc": "Read a 'niatelemetry.Lc' resource.", "READ.niatelemetry.LeafPolGrpDetails": "Read a 'niatelemetry.LeafPolGrpDetails' resource.", "READ.niatelemetry.Link": "Read a 'niatelemetry.Link' resource.", "READ.niatelemetry.MdsNeighbors": "Read a 'niatelemetry.MdsNeighbors' resource.", "READ.niatelemetry.MsoContractDetails": "Read a 'niatelemetry.MsoContractDetails' resource.", "READ.niatelemetry.MsoEpgDetails": "Read a 'niatelemetry.MsoEpgDetails' resource.", "READ.niatelemetry.MsoSchemaDetails": "Read a 'niatelemetry.MsoSchemaDetails' resource.", "READ.niatelemetry.MsoSiteDetails": "Read a 'niatelemetry.MsoSiteDetails' resource.", "READ.niatelemetry.MsoTenantDetails": "Read a 'niatelemetry.MsoTenantDetails' resource.", "READ.niatelemetry.Neighbor": "Read a 'niatelemetry.Neighbor' resource.", "READ.niatelemetry.Network": "Read a 'niatelemetry.Network' resource.", "READ.niatelemetry.NexusCloudAccount": "Read a 'niatelemetry.NexusCloudAccount' resource.", "READ.niatelemetry.NexusCloudSite": "Read a 'niatelemetry.NexusCloudSite' resource.", "READ.niatelemetry.NexusDashboardControllerDetails": "Read a 'niatelemetry.NexusDashboardControllerDetails' resource.", "READ.niatelemetry.NexusDashboardDetails": "Read a 'niatelemetry.NexusDashboardDetails' resource.", "READ.niatelemetry.NexusDashboardMemoryDetails": "Read a 'niatelemetry.NexusDashboardMemoryDetails' resource.", "READ.niatelemetry.NexusDashboards": "Read a 'niatelemetry.NexusDashboards' resource.", "READ.niatelemetry.NiaFeatureUsage": "Read a 'niatelemetry.NiaFeatureUsage' resource.", "READ.niatelemetry.NiaInventory": "Read a 'niatelemetry.NiaInventory' resource.", "READ.niatelemetry.NiaInventoryDcnm": "Read a 'niatelemetry.NiaInventoryDcnm' resource.", "READ.niatelemetry.NiaInventoryFabric": "Read a 'niatelemetry.NiaInventoryFabric' resource.", "READ.niatelemetry.NiaLicenseState": "Read a 'niatelemetry.NiaLicenseState' resource.", "READ.niatelemetry.Nicc": "Read a 'niatelemetry.Nicc' resource.", "READ.niatelemetry.PasswordStrengthCheck": "Read a 'niatelemetry.PasswordStrengthCheck' resource.", "READ.niatelemetry.PodCommPolicies": "Read a 'niatelemetry.PodCommPolicies' resource.", "READ.niatelemetry.PodSnmpPolicies": "Read a 'niatelemetry.PodSnmpPolicies' resource.", "READ.niatelemetry.PodTimeServerPolicies": "Read a 'niatelemetry.PodTimeServerPolicies' resource.", "READ.niatelemetry.Route": "Read a 'niatelemetry.Route' resource.", "READ.niatelemetry.SiteInventory": "Read a 'niatelemetry.SiteInventory' resource.", "READ.niatelemetry.SnmpSrc": "Read a 'niatelemetry.SnmpSrc' resource.", "READ.niatelemetry.SpinePolGrpDetails": "Read a 'niatelemetry.SpinePolGrpDetails' resource.", "READ.niatelemetry.SshVersionTwo": "Read a 'niatelemetry.SshVersionTwo' resource.", "READ.niatelemetry.SupervisorModuleDetails": "Read a 'niatelemetry.SupervisorModuleDetails' resource.", "READ.niatelemetry.Switch": "Read a 'niatelemetry.Switch' resource.", "READ.niatelemetry.SwitchInterface": "Read a 'niatelemetry.SwitchInterface' resource.", "READ.niatelemetry.SyslogRemoteDest": "Read a 'niatelemetry.SyslogRemoteDest' resource.", "READ.niatelemetry.SyslogSysMsg": "Read a 'niatelemetry.SyslogSysMsg' resource.", "READ.niatelemetry.SyslogSysMsgFacFilter": "Read a 'niatelemetry.SyslogSysMsgFacFilter' resource.", "READ.niatelemetry.SystemControllerDetails": "Read a 'niatelemetry.SystemControllerDetails' resource.", "READ.niatelemetry.Tenant": "Read a 'niatelemetry.Tenant' resource.", "CREATE.notification.AccountSubscription": "Create a 'notification.AccountSubscription' resource.", "DELETE.notification.AccountSubscription": "Delete a 'notification.AccountSubscription' resource.", "READ.notification.AccountSubscription": "Read a 'notification.AccountSubscription' resource.", "UPDATE.notification.AccountSubscription": "Update a 'notification.AccountSubscription' resource.", "READ.ntp.NtpServer": "Read a 'ntp.NtpServer' resource.", "CREATE.ntp.Policy": "Create a 'ntp.Policy' resource.", "DELETE.ntp.Policy": "Delete a 'ntp.Policy' resource.", "READ.ntp.Policy": "Read a 'ntp.Policy' resource.", "UPDATE.ntp.Policy": "Update a 'ntp.Policy' resource.", "READ.ntp.PolicyInventory": "Read a 'ntp.PolicyInventory' resource.", "DELETE.oauth.AccessToken": "Delete a 'oauth.AccessToken' resource.", "READ.oauth.AccessToken": "Read a 'oauth.AccessToken' resource.", "CREATE.oauth.Authorization": "Create a 'oauth.Authorization' resource.", "READ.oauth.Authorization": "Read a 'oauth.Authorization' resource.", "UPDATE.oauth.Authorization": "Update a 'oauth.Authorization' resource.", "READ.onprem.ApplianceSystemInfo": "Read a 'onprem.ApplianceSystemInfo' resource.", "READ.onprem.AuditRecord": "Read a 'onprem.AuditRecord' resource.", "READ.onprem.Upgrade": "Read a 'onprem.Upgrade' resource.", "UPDATE.onprem.Upgrade": "Update a 'onprem.Upgrade' resource.", "READ.onprem.UserPreference": "Read a 'onprem.UserPreference' resource.", "UPDATE.onprem.UserPreference": "Update a 'onprem.UserPreference' resource.", "DELETE.openapi.ApiMethodMeta": "Delete a 'openapi.ApiMethodMeta' resource.", "READ.openapi.ApiMethodMeta": "Read a 'openapi.ApiMethodMeta' resource.", "CREATE.openapi.OpenApiSpecification": "Create a 'openapi.OpenApiSpecification' resource.", "DELETE.openapi.OpenApiSpecification": "Delete a 'openapi.OpenApiSpecification' resource.", "READ.openapi.OpenApiSpecification": "Read a 'openapi.OpenApiSpecification' resource.", "UPDATE.openapi.OpenApiSpecification": "Update a 'openapi.OpenApiSpecification' resource.", "CREATE.openapi.ProcessFile": "Create a 'openapi.ProcessFile' resource.", "DELETE.openapi.ProcessFile": "Delete a 'openapi.ProcessFile' resource.", "READ.openapi.ProcessFile": "Read a 'openapi.ProcessFile' resource.", "CREATE.openapi.TaskGenerationRequest": "Create a 'openapi.TaskGenerationRequest' resource.", "DELETE.openapi.TaskGenerationRequest": "Delete a 'openapi.TaskGenerationRequest' resource.", "READ.openapi.TaskGenerationRequest": "Read a 'openapi.TaskGenerationRequest' resource.", "UPDATE.openapi.TaskGenerationRequest": "Update a 'openapi.TaskGenerationRequest' resource.", "DELETE.openapi.TaskGenerationResult": "Delete a 'openapi.TaskGenerationResult' resource.", "READ.openapi.TaskGenerationResult": "Read a 'openapi.TaskGenerationResult' resource.", "CREATE.oprs.Deployment": "Create a 'oprs.Deployment' resource.", "DELETE.oprs.Deployment": "Delete a 'oprs.Deployment' resource.", "READ.oprs.Deployment": "Read a 'oprs.Deployment' resource.", "UPDATE.oprs.Deployment": "Update a 'oprs.Deployment' resource.", "CREATE.oprs.SyncTargetListMessage": "Create a 'oprs.SyncTargetListMessage' resource.", "DELETE.oprs.SyncTargetListMessage": "Delete a 'oprs.SyncTargetListMessage' resource.", "READ.oprs.SyncTargetListMessage": "Read a 'oprs.SyncTargetListMessage' resource.", "UPDATE.oprs.SyncTargetListMessage": "Update a 'oprs.SyncTargetListMessage' resource.", "CREATE.organization.Organization": "Create a 'organization.Organization' resource.", "DELETE.organization.Organization": "Delete a 'organization.Organization' resource.", "READ.organization.Organization": "Read a 'organization.Organization' resource.", "UPDATE.organization.Organization": "Update a 'organization.Organization' resource.", "CREATE.os.BulkInstallInfo": "Create a 'os.BulkInstallInfo' resource.", "READ.os.BulkInstallInfo": "Read a 'os.BulkInstallInfo' resource.", "READ.os.Catalog": "Read a 'os.Catalog' resource.", "CREATE.os.ConfigurationFile": "Create a 'os.ConfigurationFile' resource.", "DELETE.os.ConfigurationFile": "Delete a 'os.ConfigurationFile' resource.", "READ.os.ConfigurationFile": "Read a 'os.ConfigurationFile' resource.", "UPDATE.os.ConfigurationFile": "Update a 'os.ConfigurationFile' resource.", "READ.os.Distribution": "Read a 'os.Distribution' resource.", "CREATE.os.Install": "Create a 'os.Install' resource.", "READ.os.Install": "Read a 'os.Install' resource.", "CREATE.os.OsSupport": "Create a 'os.OsSupport' resource.", "READ.os.SupportedVersion": "Read a 'os.SupportedVersion' resource.", "CREATE.os.TemplateFile": "Create a 'os.TemplateFile' resource.", "CREATE.os.ValidInstallTarget": "Create a 'os.ValidInstallTarget' resource.", "READ.os.ValidRemoteTarget": "Read a 'os.ValidRemoteTarget' resource.", "READ.partnerintegration.DcLogs": "Read a 'partnerintegration.DcLogs' resource.", "CREATE.partnerintegration.DeviceConnector": "Create a 'partnerintegration.DeviceConnector' resource.", "DELETE.partnerintegration.DeviceConnector": "Delete a 'partnerintegration.DeviceConnector' resource.", "READ.partnerintegration.DeviceConnector": "Read a 'partnerintegration.DeviceConnector' resource.", "UPDATE.partnerintegration.DeviceConnector": "Update a 'partnerintegration.DeviceConnector' resource.", "READ.partnerintegration.DocIssues": "Read a 'partnerintegration.DocIssues' resource.", "CREATE.partnerintegration.Etl": "Create a 'partnerintegration.Etl' resource.", "DELETE.partnerintegration.Etl": "Delete a 'partnerintegration.Etl' resource.", "READ.partnerintegration.Etl": "Read a 'partnerintegration.Etl' resource.", "UPDATE.partnerintegration.Etl": "Update a 'partnerintegration.Etl' resource.", "CREATE.partnerintegration.File": "Create a 'partnerintegration.File' resource.", "DELETE.partnerintegration.File": "Delete a 'partnerintegration.File' resource.", "READ.partnerintegration.File": "Read a 'partnerintegration.File' resource.", "UPDATE.partnerintegration.File": "Update a 'partnerintegration.File' resource.", "CREATE.partnerintegration.Inventory": "Create a 'partnerintegration.Inventory' resource.", "DELETE.partnerintegration.Inventory": "Delete a 'partnerintegration.Inventory' resource.", "READ.partnerintegration.Inventory": "Read a 'partnerintegration.Inventory' resource.", "UPDATE.partnerintegration.Inventory": "Update a 'partnerintegration.Inventory' resource.", "READ.partnerintegration.Logs": "Read a 'partnerintegration.Logs' resource.", "CREATE.partnerintegration.Metrics": "Create a 'partnerintegration.Metrics' resource.", "DELETE.partnerintegration.Metrics": "Delete a 'partnerintegration.Metrics' resource.", "READ.partnerintegration.Metrics": "Read a 'partnerintegration.Metrics' resource.", "UPDATE.partnerintegration.Metrics": "Update a 'partnerintegration.Metrics' resource.", "CREATE.partnerintegration.Model": "Create a 'partnerintegration.Model' resource.", "DELETE.partnerintegration.Model": "Delete a 'partnerintegration.Model' resource.", "READ.partnerintegration.Model": "Read a 'partnerintegration.Model' resource.", "UPDATE.partnerintegration.Model": "Update a 'partnerintegration.Model' resource.", "READ.pci.CoprocessorCard": "Read a 'pci.CoprocessorCard' resource.", "READ.pci.Device": "Read a 'pci.Device' resource.", "UPDATE.pci.Device": "Update a 'pci.Device' resource.", "READ.pci.Endpoint": "Read a 'pci.Endpoint' resource.", "READ.pci.Link": "Read a 'pci.Link' resource.", "UPDATE.pci.Link": "Update a 'pci.Link' resource.", "READ.pci.Node": "Read a 'pci.Node' resource.", "UPDATE.pci.Node": "Update a 'pci.Node' resource.", "READ.pci.NodeSetting": "Read a 'pci.NodeSetting' resource.", "UPDATE.pci.NodeSetting": "Update a 'pci.NodeSetting' resource.", "READ.pci.Port": "Read a 'pci.Port' resource.", "READ.pci.Slot": "Read a 'pci.Slot' resource.", "READ.pci.Switch": "Read a 'pci.Switch' resource.", "UPDATE.pci.Switch": "Update a 'pci.Switch' resource.", "READ.pci.Zone": "Read a 'pci.Zone' resource.", "READ.pool.IdMappingMember": "Read a 'pool.IdMappingMember' resource.", "CREATE.pool.IdMappingPolicy": "Create a 'pool.IdMappingPolicy' resource.", "DELETE.pool.IdMappingPolicy": "Delete a 'pool.IdMappingPolicy' resource.", "READ.pool.IdMappingPolicy": "Read a 'pool.IdMappingPolicy' resource.", "UPDATE.pool.IdMappingPolicy": "Update a 'pool.IdMappingPolicy' resource.", "READ.port.Group": "Read a 'port.Group' resource.", "UPDATE.port.Group": "Update a 'port.Group' resource.", "READ.port.MacBinding": "Read a 'port.MacBinding' resource.", "UPDATE.port.MacBinding": "Update a 'port.MacBinding' resource.", "READ.port.SubGroup": "Read a 'port.SubGroup' resource.", "UPDATE.port.SubGroup": "Update a 'port.SubGroup' resource.", "READ.power.ControlState": "Read a 'power.ControlState' resource.", "CREATE.power.Policy": "Create a 'power.Policy' resource.", "DELETE.power.Policy": "Delete a 'power.Policy' resource.", "READ.power.Policy": "Read a 'power.Policy' resource.", "UPDATE.power.Policy": "Update a 'power.Policy' resource.", "READ.power.PolicyInventory": "Read a 'power.PolicyInventory' resource.", "CREATE.power.PowerGroup": "Create a 'power.PowerGroup' resource.", "DELETE.power.PowerGroup": "Delete a 'power.PowerGroup' resource.", "READ.power.PowerGroup": "Read a 'power.PowerGroup' resource.", "UPDATE.power.PowerGroup": "Update a 'power.PowerGroup' resource.", "READ.power.PowerGroupMember": "Read a 'power.PowerGroupMember' resource.", "READ.processor.Unit": "Read a 'processor.Unit' resource.", "UPDATE.processor.Unit": "Update a 'processor.Unit' resource.", "READ.rack.UnitPersonality": "Read a 'rack.UnitPersonality' resource.", "UPDATE.rack.UnitPersonality": "Update a 'rack.UnitPersonality' resource.", "READ.recommendation.CapacityRunway": "Read a 'recommendation.CapacityRunway' resource.", "READ.recommendation.ClusterExpansion": "Read a 'recommendation.ClusterExpansion' resource.", "CREATE.recommendation.HardwareExpansionRequest": "Create a 'recommendation.HardwareExpansionRequest' resource.", "READ.recommendation.HardwareExpansionRequest": "Read a 'recommendation.HardwareExpansionRequest' resource.", "UPDATE.recommendation.HardwareExpansionRequest": "Update a 'recommendation.HardwareExpansionRequest' resource.", "CREATE.recommendation.HardwareExpansionRequestItem": "Create a 'recommendation.HardwareExpansionRequestItem' resource.", "READ.recommendation.HardwareExpansionRequestItem": "Read a 'recommendation.HardwareExpansionRequestItem' resource.", "UPDATE.recommendation.HardwareExpansionRequestItem": "Update a 'recommendation.HardwareExpansionRequestItem' resource.", "READ.recommendation.PhysicalItem": "Read a 'recommendation.PhysicalItem' resource.", "CREATE.recommendation.PurchaseOrderEstimate": "Create a 'recommendation.PurchaseOrderEstimate' resource.", "READ.recommendation.PurchaseOrderEstimate": "Read a 'recommendation.PurchaseOrderEstimate' resource.", "UPDATE.recommendation.PurchaseOrderEstimate": "Update a 'recommendation.PurchaseOrderEstimate' resource.", "READ.recommendation.PurchaseOrderList": "Read a 'recommendation.PurchaseOrderList' resource.", "READ.recommendation.SoftwareItem": "Read a 'recommendation.SoftwareItem' resource.", "CREATE.recovery.BackupConfigPolicy": "Create a 'recovery.BackupConfigPolicy' resource.", "DELETE.recovery.BackupConfigPolicy": "Delete a 'recovery.BackupConfigPolicy' resource.", "READ.recovery.BackupConfigPolicy": "Read a 'recovery.BackupConfigPolicy' resource.", "UPDATE.recovery.BackupConfigPolicy": "Update a 'recovery.BackupConfigPolicy' resource.", "CREATE.recovery.BackupProfile": "Create a 'recovery.BackupProfile' resource.", "DELETE.recovery.BackupProfile": "Delete a 'recovery.BackupProfile' resource.", "READ.recovery.BackupProfile": "Read a 'recovery.BackupProfile' resource.", "UPDATE.recovery.BackupProfile": "Update a 'recovery.BackupProfile' resource.", "READ.recovery.ConfigResult": "Read a 'recovery.ConfigResult' resource.", "READ.recovery.ConfigResultEntry": "Read a 'recovery.ConfigResultEntry' resource.", "CREATE.recovery.OnDemandBackup": "Create a 'recovery.OnDemandBackup' resource.", "DELETE.recovery.OnDemandBackup": "Delete a 'recovery.OnDemandBackup' resource.", "READ.recovery.OnDemandBackup": "Read a 'recovery.OnDemandBackup' resource.", "UPDATE.recovery.OnDemandBackup": "Update a 'recovery.OnDemandBackup' resource.", "CREATE.recovery.Restore": "Create a 'recovery.Restore' resource.", "DELETE.recovery.Restore": "Delete a 'recovery.Restore' resource.", "READ.recovery.Restore": "Read a 'recovery.Restore' resource.", "CREATE.recovery.ScheduleConfigPolicy": "Create a 'recovery.ScheduleConfigPolicy' resource.", "DELETE.recovery.ScheduleConfigPolicy": "Delete a 'recovery.ScheduleConfigPolicy' resource.", "READ.recovery.ScheduleConfigPolicy": "Read a 'recovery.ScheduleConfigPolicy' resource.", "UPDATE.recovery.ScheduleConfigPolicy": "Update a 'recovery.ScheduleConfigPolicy' resource.", "CREATE.resource.Group": "Create a 'resource.Group' resource.", "DELETE.resource.Group": "Delete a 'resource.Group' resource.", "READ.resource.Group": "Read a 'resource.Group' resource.", "UPDATE.resource.Group": "Update a 'resource.Group' resource.", "READ.resource.GroupMember": "Read a 'resource.GroupMember' resource.", "READ.resource.LicenseResourceCount": "Read a 'resource.LicenseResourceCount' resource.", "READ.resource.Membership": "Read a 'resource.Membership' resource.", "UPDATE.resource.Membership": "Update a 'resource.Membership' resource.", "READ.resource.MembershipHolder": "Read a 'resource.MembershipHolder' resource.", "CREATE.resource.Reservation": "Create a 'resource.Reservation' resource.", "DELETE.resource.Reservation": "Delete a 'resource.Reservation' resource.", "READ.resource.Reservation": "Read a 'resource.Reservation' resource.", "UPDATE.resource.Reservation": "Update a 'resource.Reservation' resource.", "CREATE.resource.SelectionCriteria": "Create a 'resource.SelectionCriteria' resource.", "DELETE.resource.SelectionCriteria": "Delete a 'resource.SelectionCriteria' resource.", "READ.resource.SelectionCriteria": "Read a 'resource.SelectionCriteria' resource.", "UPDATE.resource.SelectionCriteria": "Update a 'resource.SelectionCriteria' resource.", "READ.resource.SharedResourcesInfoHolder": "Read a 'resource.SharedResourcesInfoHolder' resource.", "DELETE.resourcepool.ChassisQualificationPolicy": "Delete a 'resourcepool.ChassisQualificationPolicy' resource.", "READ.resourcepool.ChassisQualificationPolicy": "Read a 'resourcepool.ChassisQualificationPolicy' resource.", "DELETE.resourcepool.Lease": "Delete a 'resourcepool.Lease' resource.", "READ.resourcepool.Lease": "Read a 'resourcepool.Lease' resource.", "READ.resourcepool.LeaseResource": "Read a 'resourcepool.LeaseResource' resource.", "DELETE.resourcepool.MembershipReservation": "Delete a 'resourcepool.MembershipReservation' resource.", "READ.resourcepool.MembershipReservation": "Read a 'resourcepool.MembershipReservation' resource.", "UPDATE.resourcepool.MembershipReservation": "Update a 'resourcepool.MembershipReservation' resource.", "CREATE.resourcepool.Pool": "Create a 'resourcepool.Pool' resource.", "DELETE.resourcepool.Pool": "Delete a 'resourcepool.Pool' resource.", "READ.resourcepool.Pool": "Read a 'resourcepool.Pool' resource.", "UPDATE.resourcepool.Pool": "Update a 'resourcepool.Pool' resource.", "READ.resourcepool.PoolMember": "Read a 'resourcepool.PoolMember' resource.", "CREATE.resourcepool.QualificationPolicy": "Create a 'resourcepool.QualificationPolicy' resource.", "DELETE.resourcepool.QualificationPolicy": "Delete a 'resourcepool.QualificationPolicy' resource.", "READ.resourcepool.QualificationPolicy": "Read a 'resourcepool.QualificationPolicy' resource.", "UPDATE.resourcepool.QualificationPolicy": "Update a 'resourcepool.QualificationPolicy' resource.", "CREATE.resourcepool.Reservation": "Create a 'resourcepool.Reservation' resource.", "DELETE.resourcepool.Reservation": "Delete a 'resourcepool.Reservation' resource.", "READ.resourcepool.Reservation": "Read a 'resourcepool.Reservation' resource.", "UPDATE.resourcepool.Reservation": "Update a 'resourcepool.Reservation' resource.", "READ.resourcepool.Universe": "Read a 'resourcepool.Universe' resource.", "CREATE.rproxy.ReverseProxy": "Create a 'rproxy.ReverseProxy' resource.", "CREATE.scheduler.SchedulePolicy": "Create a 'scheduler.SchedulePolicy' resource.", "DELETE.scheduler.SchedulePolicy": "Delete a 'scheduler.SchedulePolicy' resource.", "READ.scheduler.SchedulePolicy": "Read a 'scheduler.SchedulePolicy' resource.", "UPDATE.scheduler.SchedulePolicy": "Update a 'scheduler.SchedulePolicy' resource.", "READ.scheduler.TaskResult": "Read a 'scheduler.TaskResult' resource.", "CREATE.scheduler.TaskSchedule": "Create a 'scheduler.TaskSchedule' resource.", "DELETE.scheduler.TaskSchedule": "Delete a 'scheduler.TaskSchedule' resource.", "READ.scheduler.TaskSchedule": "Read a 'scheduler.TaskSchedule' resource.", "UPDATE.scheduler.TaskSchedule": "Update a 'scheduler.TaskSchedule' resource.", "CREATE.sdaaci.Connection": "Create a 'sdaaci.Connection' resource.", "DELETE.sdaaci.Connection": "Delete a 'sdaaci.Connection' resource.", "READ.sdaaci.Connection": "Read a 'sdaaci.Connection' resource.", "UPDATE.sdaaci.Connection": "Update a 'sdaaci.Connection' resource.", "CREATE.sdaaci.ConnectionDetail": "Create a 'sdaaci.ConnectionDetail' resource.", "DELETE.sdaaci.ConnectionDetail": "Delete a 'sdaaci.ConnectionDetail' resource.", "READ.sdaaci.ConnectionDetail": "Read a 'sdaaci.ConnectionDetail' resource.", "UPDATE.sdaaci.ConnectionDetail": "Update a 'sdaaci.ConnectionDetail' resource.", "CREATE.sdcard.Policy": "Create a 'sdcard.Policy' resource.", "DELETE.sdcard.Policy": "Delete a 'sdcard.Policy' resource.", "READ.sdcard.Policy": "Read a 'sdcard.Policy' resource.", "UPDATE.sdcard.Policy": "Update a 'sdcard.Policy' resource.", "READ.sdcard.PolicyInventory": "Read a 'sdcard.PolicyInventory' resource.", "READ.search.SearchItem": "Read a 'search.SearchItem' resource.", "READ.search.TagItem": "Read a 'search.TagItem' resource.", "READ.security.Unit": "Read a 'security.Unit' resource.", "UPDATE.security.Unit": "Update a 'security.Unit' resource.", "READ.server.ConfigChangeDetail": "Read a 'server.ConfigChangeDetail' resource.", "CREATE.server.ConfigImport": "Create a 'server.ConfigImport' resource.", "READ.server.ConfigImport": "Read a 'server.ConfigImport' resource.", "READ.server.ConfigResult": "Read a 'server.ConfigResult' resource.", "READ.server.ConfigResultEntry": "Read a 'server.ConfigResultEntry' resource.", "CREATE.server.DiagnosticStatus": "Create a 'server.DiagnosticStatus' resource.", "DELETE.server.DiagnosticStatus": "Delete a 'server.DiagnosticStatus' resource.", "READ.server.DiagnosticStatus": "Read a 'server.DiagnosticStatus' resource.", "UPDATE.server.DiagnosticStatus": "Update a 'server.DiagnosticStatus' resource.", "CREATE.server.Diagnostics": "Create a 'server.Diagnostics' resource.", "DELETE.server.Diagnostics": "Delete a 'server.Diagnostics' resource.", "READ.server.Diagnostics": "Read a 'server.Diagnostics' resource.", "UPDATE.server.Diagnostics": "Update a 'server.Diagnostics' resource.", "READ.server.Disruption": "Read a 'server.Disruption' resource.", "DELETE.server.MigrationKeyDetails": "Delete a 'server.MigrationKeyDetails' resource.", "READ.server.MigrationKeyDetails": "Read a 'server.MigrationKeyDetails' resource.", "CREATE.server.Profile": "Create a 'server.Profile' resource.", "DELETE.server.Profile": "Delete a 'server.Profile' resource.", "READ.server.Profile": "Read a 'server.Profile' resource.", "UPDATE.server.Profile": "Update a 'server.Profile' resource.", "READ.server.ProfilePendingChangeEval": "Read a 'server.ProfilePendingChangeEval' resource.", "CREATE.server.ProfileTemplate": "Create a 'server.ProfileTemplate' resource.", "DELETE.server.ProfileTemplate": "Delete a 'server.ProfileTemplate' resource.", "READ.server.ProfileTemplate": "Read a 'server.ProfileTemplate' resource.", "UPDATE.server.ProfileTemplate": "Update a 'server.ProfileTemplate' resource.", "READ.servicenow.ChangeRequest": "Read a 'servicenow.ChangeRequest' resource.", "READ.servicenow.ChangeRequestDoc": "Read a 'servicenow.ChangeRequestDoc' resource.", "READ.servicenow.Incident": "Read a 'servicenow.Incident' resource.", "READ.servicenow.IncidentDoc": "Read a 'servicenow.IncidentDoc' resource.", "CREATE.smtp.Policy": "Create a 'smtp.Policy' resource.", "DELETE.smtp.Policy": "Delete a 'smtp.Policy' resource.", "READ.smtp.Policy": "Read a 'smtp.Policy' resource.", "UPDATE.smtp.Policy": "Update a 'smtp.Policy' resource.", "READ.smtp.PolicyInventory": "Read a 'smtp.PolicyInventory' resource.", "CREATE.smtp.PolicyTest": "Create a 'smtp.PolicyTest' resource.", "DELETE.smtp.PolicyTest": "Delete a 'smtp.PolicyTest' resource.", "READ.smtp.PolicyTest": "Read a 'smtp.PolicyTest' resource.", "UPDATE.smtp.PolicyTest": "Update a 'smtp.PolicyTest' resource.", "CREATE.snmp.Policy": "Create a 'snmp.Policy' resource.", "DELETE.snmp.Policy": "Delete a 'snmp.Policy' resource.", "READ.snmp.Policy": "Read a 'snmp.Policy' resource.", "UPDATE.snmp.Policy": "Update a 'snmp.Policy' resource.", "READ.snmp.PolicyInventory": "Read a 'snmp.PolicyInventory' resource.", "CREATE.software.ApplianceDistributable": "Create a 'software.ApplianceDistributable' resource.", "DELETE.software.ApplianceDistributable": "Delete a 'software.ApplianceDistributable' resource.", "READ.software.ApplianceDistributable": "Read a 'software.ApplianceDistributable' resource.", "UPDATE.software.ApplianceDistributable": "Update a 'software.ApplianceDistributable' resource.", "READ.software.DownloadHistory": "Read a 'software.DownloadHistory' resource.", "CREATE.software.HciBundleDistributable": "Create a 'software.HciBundleDistributable' resource.", "DELETE.software.HciBundleDistributable": "Delete a 'software.HciBundleDistributable' resource.", "READ.software.HciBundleDistributable": "Read a 'software.HciBundleDistributable' resource.", "UPDATE.software.HciBundleDistributable": "Update a 'software.HciBundleDistributable' resource.", "CREATE.software.HciDistributable": "Create a 'software.HciDistributable' resource.", "DELETE.software.HciDistributable": "Delete a 'software.HciDistributable' resource.", "READ.software.HciDistributable": "Read a 'software.HciDistributable' resource.", "UPDATE.software.HciDistributable": "Update a 'software.HciDistributable' resource.", "READ.software.HclMeta": "Read a 'software.HclMeta' resource.", "CREATE.software.HyperflexBundleDistributable": "Create a 'software.HyperflexBundleDistributable' resource.", "DELETE.software.HyperflexBundleDistributable": "Delete a 'software.HyperflexBundleDistributable' resource.", "READ.software.HyperflexBundleDistributable": "Read a 'software.HyperflexBundleDistributable' resource.", "UPDATE.software.HyperflexBundleDistributable": "Update a 'software.HyperflexBundleDistributable' resource.", "CREATE.software.HyperflexDistributable": "Create a 'software.HyperflexDistributable' resource.", "DELETE.software.HyperflexDistributable": "Delete a 'software.HyperflexDistributable' resource.", "READ.software.HyperflexDistributable": "Read a 'software.HyperflexDistributable' resource.", "UPDATE.software.HyperflexDistributable": "Update a 'software.HyperflexDistributable' resource.", "CREATE.software.IksBundleDistributable": "Create a 'software.IksBundleDistributable' resource.", "DELETE.software.IksBundleDistributable": "Delete a 'software.IksBundleDistributable' resource.", "READ.software.IksBundleDistributable": "Read a 'software.IksBundleDistributable' resource.", "UPDATE.software.IksBundleDistributable": "Update a 'software.IksBundleDistributable' resource.", "CREATE.software.ReleaseMeta": "Create a 'software.ReleaseMeta' resource.", "DELETE.software.ReleaseMeta": "Delete a 'software.ReleaseMeta' resource.", "READ.software.ReleaseMeta": "Read a 'software.ReleaseMeta' resource.", "UPDATE.software.ReleaseMeta": "Update a 'software.ReleaseMeta' resource.", "CREATE.software.SolutionDistributable": "Create a 'software.SolutionDistributable' resource.", "DELETE.software.SolutionDistributable": "Delete a 'software.SolutionDistributable' resource.", "READ.software.SolutionDistributable": "Read a 'software.SolutionDistributable' resource.", "UPDATE.software.SolutionDistributable": "Update a 'software.SolutionDistributable' resource.", "CREATE.software.UcsdBundleDistributable": "Create a 'software.UcsdBundleDistributable' resource.", "DELETE.software.UcsdBundleDistributable": "Delete a 'software.UcsdBundleDistributable' resource.", "READ.software.UcsdBundleDistributable": "Read a 'software.UcsdBundleDistributable' resource.", "UPDATE.software.UcsdBundleDistributable": "Update a 'software.UcsdBundleDistributable' resource.", "CREATE.software.UcsdDistributable": "Create a 'software.UcsdDistributable' resource.", "DELETE.software.UcsdDistributable": "Delete a 'software.UcsdDistributable' resource.", "READ.software.UcsdDistributable": "Read a 'software.UcsdDistributable' resource.", "UPDATE.software.UcsdDistributable": "Update a 'software.UcsdDistributable' resource.", "CREATE.softwarerepository.Authorization": "Create a 'softwarerepository.Authorization' resource.", "READ.softwarerepository.Authorization": "Read a 'softwarerepository.Authorization' resource.", "UPDATE.softwarerepository.Authorization": "Update a 'softwarerepository.Authorization' resource.", "READ.softwarerepository.CachedImage": "Read a 'softwarerepository.CachedImage' resource.", "READ.softwarerepository.Catalog": "Read a 'softwarerepository.Catalog' resource.", "READ.softwarerepository.CategoryMapper": "Read a 'softwarerepository.CategoryMapper' resource.", "READ.softwarerepository.CategoryMapperModel": "Read a 'softwarerepository.CategoryMapperModel' resource.", "READ.softwarerepository.CategorySupportConstraint": "Read a 'softwarerepository.CategorySupportConstraint' resource.", "READ.softwarerepository.CategoryUnsupportedModels": "Read a 'softwarerepository.CategoryUnsupportedModels' resource.", "READ.softwarerepository.DownloadSpec": "Read a 'softwarerepository.DownloadSpec' resource.", "CREATE.softwarerepository.OperatingSystemFile": "Create a 'softwarerepository.OperatingSystemFile' resource.", "DELETE.softwarerepository.OperatingSystemFile": "Delete a 'softwarerepository.OperatingSystemFile' resource.", "READ.softwarerepository.OperatingSystemFile": "Read a 'softwarerepository.OperatingSystemFile' resource.", "UPDATE.softwarerepository.OperatingSystemFile": "Update a 'softwarerepository.OperatingSystemFile' resource.", "READ.softwarerepository.Release": "Read a 'softwarerepository.Release' resource.", "CREATE.sol.Policy": "Create a 'sol.Policy' resource.", "DELETE.sol.Policy": "Delete a 'sol.Policy' resource.", "READ.sol.Policy": "Read a 'sol.Policy' resource.", "UPDATE.sol.Policy": "Update a 'sol.Policy' resource.", "READ.sol.PolicyInventory": "Read a 'sol.PolicyInventory' resource.", "CREATE.ssh.Policy": "Create a 'ssh.Policy' resource.", "DELETE.ssh.Policy": "Delete a 'ssh.Policy' resource.", "READ.ssh.Policy": "Read a 'ssh.Policy' resource.", "UPDATE.ssh.Policy": "Update a 'ssh.Policy' resource.", "READ.ssh.PolicyInventory": "Read a 'ssh.PolicyInventory' resource.", "READ.storage.BatteryBackupUnit": "Read a 'storage.BatteryBackupUnit' resource.", "UPDATE.storage.BatteryBackupUnit": "Update a 'storage.BatteryBackupUnit' resource.", "READ.storage.Controller": "Read a 'storage.Controller' resource.", "UPDATE.storage.Controller": "Update a 'storage.Controller' resource.", "READ.storage.ControllerDrive": "Read a 'storage.ControllerDrive' resource.", "READ.storage.DiskGroup": "Read a 'storage.DiskGroup' resource.", "UPDATE.storage.DiskGroup": "Update a 'storage.DiskGroup' resource.", "READ.storage.DiskSlot": "Read a 'storage.DiskSlot' resource.", "CREATE.storage.DriveGroup": "Create a 'storage.DriveGroup' resource.", "DELETE.storage.DriveGroup": "Delete a 'storage.DriveGroup' resource.", "READ.storage.DriveGroup": "Read a 'storage.DriveGroup' resource.", "UPDATE.storage.DriveGroup": "Update a 'storage.DriveGroup' resource.", "CREATE.storage.DriveSecurityPolicy": "Create a 'storage.DriveSecurityPolicy' resource.", "DELETE.storage.DriveSecurityPolicy": "Delete a 'storage.DriveSecurityPolicy' resource.", "READ.storage.DriveSecurityPolicy": "Read a 'storage.DriveSecurityPolicy' resource.", "UPDATE.storage.DriveSecurityPolicy": "Update a 'storage.DriveSecurityPolicy' resource.", "READ.storage.Enclosure": "Read a 'storage.Enclosure' resource.", "UPDATE.storage.Enclosure": "Update a 'storage.Enclosure' resource.", "READ.storage.EnclosureDisk": "Read a 'storage.EnclosureDisk' resource.", "UPDATE.storage.EnclosureDisk": "Update a 'storage.EnclosureDisk' resource.", "READ.storage.EnclosureDiskSlotEp": "Read a 'storage.EnclosureDiskSlotEp' resource.", "UPDATE.storage.EnclosureDiskSlotEp": "Update a 'storage.EnclosureDiskSlotEp' resource.", "READ.storage.FileItem": "Read a 'storage.FileItem' resource.", "READ.storage.FlexFlashController": "Read a 'storage.FlexFlashController' resource.", "UPDATE.storage.FlexFlashController": "Update a 'storage.FlexFlashController' resource.", "READ.storage.FlexFlashControllerProps": "Read a 'storage.FlexFlashControllerProps' resource.", "UPDATE.storage.FlexFlashControllerProps": "Update a 'storage.FlexFlashControllerProps' resource.", "READ.storage.FlexFlashPhysicalDrive": "Read a 'storage.FlexFlashPhysicalDrive' resource.", "UPDATE.storage.FlexFlashPhysicalDrive": "Update a 'storage.FlexFlashPhysicalDrive' resource.", "READ.storage.FlexFlashVirtualDrive": "Read a 'storage.FlexFlashVirtualDrive' resource.", "UPDATE.storage.FlexFlashVirtualDrive": "Update a 'storage.FlexFlashVirtualDrive' resource.", "READ.storage.FlexUtilController": "Read a 'storage.FlexUtilController' resource.", "UPDATE.storage.FlexUtilController": "Update a 'storage.FlexUtilController' resource.", "READ.storage.FlexUtilPhysicalDrive": "Read a 'storage.FlexUtilPhysicalDrive' resource.", "UPDATE.storage.FlexUtilPhysicalDrive": "Update a 'storage.FlexUtilPhysicalDrive' resource.", "READ.storage.FlexUtilVirtualDrive": "Read a 'storage.FlexUtilVirtualDrive' resource.", "UPDATE.storage.FlexUtilVirtualDrive": "Update a 'storage.FlexUtilVirtualDrive' resource.", "READ.storage.HitachiArray": "Read a 'storage.HitachiArray' resource.", "UPDATE.storage.HitachiArray": "Update a 'storage.HitachiArray' resource.", "READ.storage.HitachiController": "Read a 'storage.HitachiController' resource.", "READ.storage.HitachiDisk": "Read a 'storage.HitachiDisk' resource.", "READ.storage.HitachiExternalParityGroup": "Read a 'storage.HitachiExternalParityGroup' resource.", "READ.storage.HitachiExternalPathGroup": "Read a 'storage.HitachiExternalPathGroup' resource.", "READ.storage.HitachiExternalStorageLun": "Read a 'storage.HitachiExternalStorageLun' resource.", "READ.storage.HitachiExternalStoragePort": "Read a 'storage.HitachiExternalStoragePort' resource.", "READ.storage.HitachiHost": "Read a 'storage.HitachiHost' resource.", "READ.storage.HitachiHostLun": "Read a 'storage.HitachiHostLun' resource.", "READ.storage.HitachiNvmSubsystem": "Read a 'storage.HitachiNvmSubsystem' resource.", "READ.storage.HitachiParityGroup": "Read a 'storage.HitachiParityGroup' resource.", "READ.storage.HitachiPool": "Read a 'storage.HitachiPool' resource.", "READ.storage.HitachiPort": "Read a 'storage.HitachiPort' resource.", "READ.storage.HitachiRemoteCopyPairGad": "Read a 'storage.HitachiRemoteCopyPairGad' resource.", "READ.storage.HitachiRemoteCopyPairTc": "Read a 'storage.HitachiRemoteCopyPairTc' resource.", "READ.storage.HitachiRemoteCopyPairUr": "Read a 'storage.HitachiRemoteCopyPairUr' resource.", "READ.storage.HitachiRemoteReplication": "Read a 'storage.HitachiRemoteReplication' resource.", "READ.storage.HitachiSnapshot": "Read a 'storage.HitachiSnapshot' resource.", "READ.storage.HitachiVolume": "Read a 'storage.HitachiVolume' resource.", "READ.storage.HitachiVolumeMigrationPair": "Read a 'storage.HitachiVolumeMigrationPair' resource.", "READ.storage.HyperFlexStorageContainer": "Read a 'storage.HyperFlexStorageContainer' resource.", "READ.storage.HyperFlexVolume": "Read a 'storage.HyperFlexVolume' resource.", "READ.storage.Item": "Read a 'storage.Item' resource.", "READ.storage.KnoxSecureDriveConfiguration": "Read a 'storage.KnoxSecureDriveConfiguration' resource.", "READ.storage.NetAppAggregate": "Read a 'storage.NetAppAggregate' resource.", "READ.storage.NetAppAggregateEvent": "Read a 'storage.NetAppAggregateEvent' resource.", "READ.storage.NetAppBaseDisk": "Read a 'storage.NetAppBaseDisk' resource.", "READ.storage.NetAppCifsService": "Read a 'storage.NetAppCifsService' resource.", "READ.storage.NetAppCifsShare": "Read a 'storage.NetAppCifsShare' resource.", "READ.storage.NetAppCloudTarget": "Read a 'storage.NetAppCloudTarget' resource.", "READ.storage.NetAppCluster": "Read a 'storage.NetAppCluster' resource.", "UPDATE.storage.NetAppCluster": "Update a 'storage.NetAppCluster' resource.", "READ.storage.NetAppClusterEvent": "Read a 'storage.NetAppClusterEvent' resource.", "READ.storage.NetAppClusterSnapMirrorPolicy": "Read a 'storage.NetAppClusterSnapMirrorPolicy' resource.", "READ.storage.NetAppClusterSnapshotPolicy": "Read a 'storage.NetAppClusterSnapshotPolicy' resource.", "READ.storage.NetAppDataIpInterface": "Read a 'storage.NetAppDataIpInterface' resource.", "READ.storage.NetAppDataIpInterfaceEvent": "Read a 'storage.NetAppDataIpInterfaceEvent' resource.", "READ.storage.NetAppDiskEvent": "Read a 'storage.NetAppDiskEvent' resource.", "READ.storage.NetAppEthernetPort": "Read a 'storage.NetAppEthernetPort' resource.", "READ.storage.NetAppEthernetPortEvent": "Read a 'storage.NetAppEthernetPortEvent' resource.", "READ.storage.NetAppExportPolicy": "Read a 'storage.NetAppExportPolicy' resource.", "READ.storage.NetAppFcInterface": "Read a 'storage.NetAppFcInterface' resource.", "READ.storage.NetAppFcInterfaceEvent": "Read a 'storage.NetAppFcInterfaceEvent' resource.", "READ.storage.NetAppFcPort": "Read a 'storage.NetAppFcPort' resource.", "READ.storage.NetAppFcPortEvent": "Read a 'storage.NetAppFcPortEvent' resource.", "READ.storage.NetAppInitiatorGroup": "Read a 'storage.NetAppInitiatorGroup' resource.", "READ.storage.NetAppIpInterface": "Read a 'storage.NetAppIpInterface' resource.", "READ.storage.NetAppIpInterfaceEvent": "Read a 'storage.NetAppIpInterfaceEvent' resource.", "READ.storage.NetAppIscsiService": "Read a 'storage.NetAppIscsiService' resource.", "READ.storage.NetAppLicense": "Read a 'storage.NetAppLicense' resource.", "READ.storage.NetAppLun": "Read a 'storage.NetAppLun' resource.", "READ.storage.NetAppLunEvent": "Read a 'storage.NetAppLunEvent' resource.", "READ.storage.NetAppLunMap": "Read a 'storage.NetAppLunMap' resource.", "READ.storage.NetAppNamespace": "Read a 'storage.NetAppNamespace' resource.", "READ.storage.NetAppNfsClient": "Read a 'storage.NetAppNfsClient' resource.", "READ.storage.NetAppNfsService": "Read a 'storage.NetAppNfsService' resource.", "READ.storage.NetAppNode": "Read a 'storage.NetAppNode' resource.", "READ.storage.NetAppNodeCdpNeighbor": "Read a 'storage.NetAppNodeCdpNeighbor' resource.", "READ.storage.NetAppNodeEvent": "Read a 'storage.NetAppNodeEvent' resource.", "READ.storage.NetAppNonDataIpInterface": "Read a 'storage.NetAppNonDataIpInterface' resource.", "READ.storage.NetAppNonDataIpInterfaceEvent": "Read a 'storage.NetAppNonDataIpInterfaceEvent' resource.", "READ.storage.NetAppNtpServer": "Read a 'storage.NetAppNtpServer' resource.", "READ.storage.NetAppQtree": "Read a 'storage.NetAppQtree' resource.", "READ.storage.NetAppSchedule": "Read a 'storage.NetAppSchedule' resource.", "READ.storage.NetAppSensor": "Read a 'storage.NetAppSensor' resource.", "READ.storage.NetAppSnapMirrorRelationship": "Read a 'storage.NetAppSnapMirrorRelationship' resource.", "READ.storage.NetAppStorageVm": "Read a 'storage.NetAppStorageVm' resource.", "READ.storage.NetAppSvmEvent": "Read a 'storage.NetAppSvmEvent' resource.", "READ.storage.NetAppSvmSnapMirrorPolicy": "Read a 'storage.NetAppSvmSnapMirrorPolicy' resource.", "READ.storage.NetAppSvmSnapshotPolicy": "Read a 'storage.NetAppSvmSnapshotPolicy' resource.", "READ.storage.NetAppVolume": "Read a 'storage.NetAppVolume' resource.", "READ.storage.NetAppVolumeEvent": "Read a 'storage.NetAppVolumeEvent' resource.", "READ.storage.NetAppVolumeSnapshot": "Read a 'storage.NetAppVolumeSnapshot' resource.", "READ.storage.NvmeRaidConfiguration": "Read a 'storage.NvmeRaidConfiguration' resource.", "READ.storage.PhysicalDisk": "Read a 'storage.PhysicalDisk' resource.", "UPDATE.storage.PhysicalDisk": "Update a 'storage.PhysicalDisk' resource.", "READ.storage.PhysicalDiskExtension": "Read a 'storage.PhysicalDiskExtension' resource.", "UPDATE.storage.PhysicalDiskExtension": "Update a 'storage.PhysicalDiskExtension' resource.", "READ.storage.PhysicalDiskUsage": "Read a 'storage.PhysicalDiskUsage' resource.", "UPDATE.storage.PhysicalDiskUsage": "Update a 'storage.PhysicalDiskUsage' resource.", "READ.storage.PureArray": "Read a 'storage.PureArray' resource.", "UPDATE.storage.PureArray": "Update a 'storage.PureArray' resource.", "READ.storage.PureArrayAlerts": "Read a 'storage.PureArrayAlerts' resource.", "READ.storage.PureBlade": "Read a 'storage.PureBlade' resource.", "READ.storage.PureController": "Read a 'storage.PureController' resource.", "READ.storage.PureDirectory": "Read a 'storage.PureDirectory' resource.", "READ.storage.PureDirectoryExport": "Read a 'storage.PureDirectoryExport' resource.", "READ.storage.PureDirectoryPolicy": "Read a 'storage.PureDirectoryPolicy' resource.", "READ.storage.PureDirectoryQuota": "Read a 'storage.PureDirectoryQuota' resource.", "READ.storage.PureDirectorySnapshot": "Read a 'storage.PureDirectorySnapshot' resource.", "READ.storage.PureDisk": "Read a 'storage.PureDisk' resource.", "READ.storage.PureFileSystems": "Read a 'storage.PureFileSystems' resource.", "READ.storage.PureFlashBladeFileSystem": "Read a 'storage.PureFlashBladeFileSystem' resource.", "READ.storage.PureFlashBladeSystem": "Read a 'storage.PureFlashBladeSystem' resource.", "UPDATE.storage.PureFlashBladeSystem": "Update a 'storage.PureFlashBladeSystem' resource.", "READ.storage.PureHost": "Read a 'storage.PureHost' resource.", "READ.storage.PureHostGroup": "Read a 'storage.PureHostGroup' resource.", "READ.storage.PureHostLun": "Read a 'storage.PureHostLun' resource.", "READ.storage.PureManagementAccessPolicy": "Read a 'storage.PureManagementAccessPolicy' resource.", "READ.storage.PureNfsPolicyRule": "Read a 'storage.PureNfsPolicyRule' resource.", "READ.storage.PureObjectBucket": "Read a 'storage.PureObjectBucket' resource.", "READ.storage.PureObjectStoreAccount": "Read a 'storage.PureObjectStoreAccount' resource.", "READ.storage.PureObjectStoreUser": "Read a 'storage.PureObjectStoreUser' resource.", "READ.storage.PurePod": "Read a 'storage.PurePod' resource.", "READ.storage.PurePort": "Read a 'storage.PurePort' resource.", "READ.storage.PureProtectionGroup": "Read a 'storage.PureProtectionGroup' resource.", "READ.storage.PureProtectionGroupSnapshot": "Read a 'storage.PureProtectionGroupSnapshot' resource.", "READ.storage.PureQuotaPolicyRule": "Read a 'storage.PureQuotaPolicyRule' resource.", "READ.storage.PureRealm": "Read a 'storage.PureRealm' resource.", "READ.storage.PureReplicationSchedule": "Read a 'storage.PureReplicationSchedule' resource.", "READ.storage.PureSmbPolicyRule": "Read a 'storage.PureSmbPolicyRule' resource.", "READ.storage.PureSnapshotSchedule": "Read a 'storage.PureSnapshotSchedule' resource.", "READ.storage.PureTargetArray": "Read a 'storage.PureTargetArray' resource.", "READ.storage.PureVolume": "Read a 'storage.PureVolume' resource.", "READ.storage.PureVolumeGroup": "Read a 'storage.PureVolumeGroup' resource.", "READ.storage.PureVolumeSnapshot": "Read a 'storage.PureVolumeSnapshot' resource.", "READ.storage.SasExpander": "Read a 'storage.SasExpander' resource.", "UPDATE.storage.SasExpander": "Update a 'storage.SasExpander' resource.", "READ.storage.SasPort": "Read a 'storage.SasPort' resource.", "UPDATE.storage.SasPort": "Update a 'storage.SasPort' resource.", "READ.storage.Span": "Read a 'storage.Span' resource.", "UPDATE.storage.Span": "Update a 'storage.Span' resource.", "CREATE.storage.StoragePolicy": "Create a 'storage.StoragePolicy' resource.", "DELETE.storage.StoragePolicy": "Delete a 'storage.StoragePolicy' resource.", "READ.storage.StoragePolicy": "Read a 'storage.StoragePolicy' resource.", "UPDATE.storage.StoragePolicy": "Update a 'storage.StoragePolicy' resource.", "READ.storage.VdMemberEp": "Read a 'storage.VdMemberEp' resource.", "UPDATE.storage.VdMemberEp": "Update a 'storage.VdMemberEp' resource.", "READ.storage.VirtualDrive": "Read a 'storage.VirtualDrive' resource.", "UPDATE.storage.VirtualDrive": "Update a 'storage.VirtualDrive' resource.", "READ.storage.VirtualDriveContainer": "Read a 'storage.VirtualDriveContainer' resource.", "UPDATE.storage.VirtualDriveContainer": "Update a 'storage.VirtualDriveContainer' resource.", "READ.storage.VirtualDriveExtension": "Read a 'storage.VirtualDriveExtension' resource.", "UPDATE.storage.VirtualDriveExtension": "Update a 'storage.VirtualDriveExtension' resource.", "READ.storage.VirtualDriveIdentity": "Read a 'storage.VirtualDriveIdentity' resource.", "CREATE.syslog.Policy": "Create a 'syslog.Policy' resource.", "DELETE.syslog.Policy": "Delete a 'syslog.Policy' resource.", "READ.syslog.Policy": "Read a 'syslog.Policy' resource.", "UPDATE.syslog.Policy": "Update a 'syslog.Policy' resource.", "READ.syslog.PolicyInventory": "Read a 'syslog.PolicyInventory' resource.", "READ.tam.AdvisoryCount": "Read a 'tam.AdvisoryCount' resource.", "READ.tam.AdvisoryDefinition": "Read a 'tam.AdvisoryDefinition' resource.", "CREATE.tam.AdvisoryInfo": "Create a 'tam.AdvisoryInfo' resource.", "DELETE.tam.AdvisoryInfo": "Delete a 'tam.AdvisoryInfo' resource.", "READ.tam.AdvisoryInfo": "Read a 'tam.AdvisoryInfo' resource.", "UPDATE.tam.AdvisoryInfo": "Update a 'tam.AdvisoryInfo' resource.", "READ.tam.AdvisoryInstance": "Read a 'tam.AdvisoryInstance' resource.", "READ.tam.SecurityAdvisory": "Read a 'tam.SecurityAdvisory' resource.", "CREATE.task.CatalystSdwanScopedInventory": "Create a 'task.CatalystSdwanScopedInventory' resource.", "CREATE.task.FabricMosScopedInventory": "Create a 'task.FabricMosScopedInventory' resource.", "CREATE.task.HciScopedInventory": "Create a 'task.HciScopedInventory' resource.", "CREATE.task.HitachiScopedInventory": "Create a 'task.HitachiScopedInventory' resource.", "CREATE.task.HyperFlexManagementScopedInventory": "Create a 'task.HyperFlexManagementScopedInventory' resource.", "CREATE.task.HyperflexScopedInventory": "Create a 'task.HyperflexScopedInventory' resource.", "CREATE.task.MdsScopedInventory": "Create a 'task.MdsScopedInventory' resource.", "CREATE.task.MdsSystemScopedInventory": "Create a 'task.MdsSystemScopedInventory' resource.", "CREATE.task.MerakiScopedInventory": "Create a 'task.MerakiScopedInventory' resource.", "CREATE.task.NetAppScopedInventory": "Create a 'task.NetAppScopedInventory' resource.", "CREATE.task.NexusScopedInventory": "Create a 'task.NexusScopedInventory' resource.", "CREATE.task.NexusSystemScopedInventory": "Create a 'task.NexusSystemScopedInventory' resource.", "CREATE.task.NexusVlanScopedInventory": "Create a 'task.NexusVlanScopedInventory' resource.", "CREATE.task.PureFlashBladeScopedInventory": "Create a 'task.PureFlashBladeScopedInventory' resource.", "CREATE.task.PureScopedInventory": "Create a 'task.PureScopedInventory' resource.", "CREATE.task.ServerScopedInventory": "Create a 'task.ServerScopedInventory' resource.", "CREATE.techsupportmanagement.CollectionControlPolicy": "Create a 'techsupportmanagement.CollectionControlPolicy' resource.", "DELETE.techsupportmanagement.CollectionControlPolicy": "Delete a 'techsupportmanagement.CollectionControlPolicy' resource.", "READ.techsupportmanagement.CollectionControlPolicy": "Read a 'techsupportmanagement.CollectionControlPolicy' resource.", "UPDATE.techsupportmanagement.CollectionControlPolicy": "Update a 'techsupportmanagement.CollectionControlPolicy' resource.", "READ.techsupportmanagement.Download": "Read a 'techsupportmanagement.Download' resource.", "READ.techsupportmanagement.EndPoint": "Read a 'techsupportmanagement.EndPoint' resource.", "CREATE.techsupportmanagement.TechSupportBundle": "Create a 'techsupportmanagement.TechSupportBundle' resource.", "DELETE.techsupportmanagement.TechSupportBundle": "Delete a 'techsupportmanagement.TechSupportBundle' resource.", "READ.techsupportmanagement.TechSupportBundle": "Read a 'techsupportmanagement.TechSupportBundle' resource.", "READ.techsupportmanagement.TechSupportStatus": "Read a 'techsupportmanagement.TechSupportStatus' resource.", "READ.terminal.AuditLog": "Read a 'terminal.AuditLog' resource.", "CREATE.thermal.Policy": "Create a 'thermal.Policy' resource.", "DELETE.thermal.Policy": "Delete a 'thermal.Policy' resource.", "READ.thermal.Policy": "Read a 'thermal.Policy' resource.", "UPDATE.thermal.Policy": "Update a 'thermal.Policy' resource.", "READ.thermal.PolicyInventory": "Read a 'thermal.PolicyInventory' resource.", "READ.top.System": "Read a 'top.System' resource.", "UPDATE.top.System": "Update a 'top.System' resource.", "DELETE.ucsd.BackupInfo": "Delete a 'ucsd.BackupInfo' resource.", "READ.ucsd.BackupInfo": "Read a 'ucsd.BackupInfo' resource.", "READ.uuidpool.Block": "Read a 'uuidpool.Block' resource.", "CREATE.uuidpool.Pool": "Create a 'uuidpool.Pool' resource.", "DELETE.uuidpool.Pool": "Delete a 'uuidpool.Pool' resource.", "READ.uuidpool.Pool": "Read a 'uuidpool.Pool' resource.", "UPDATE.uuidpool.Pool": "Update a 'uuidpool.Pool' resource.", "READ.uuidpool.PoolMember": "Read a 'uuidpool.PoolMember' resource.", "CREATE.uuidpool.Reservation": "Create a 'uuidpool.Reservation' resource.", "DELETE.uuidpool.Reservation": "Delete a 'uuidpool.Reservation' resource.", "READ.uuidpool.Reservation": "Read a 'uuidpool.Reservation' resource.", "READ.uuidpool.Universe": "Read a 'uuidpool.Universe' resource.", "DELETE.uuidpool.UuidLease": "Delete a 'uuidpool.UuidLease' resource.", "READ.uuidpool.UuidLease": "Read a 'uuidpool.UuidLease' resource.", "READ.view.HealthStatus": "Read a 'view.HealthStatus' resource.", "READ.view.Server": "Read a 'view.Server' resource.", "CREATE.virtualization.EsxiConsole": "Create a 'virtualization.EsxiConsole' resource.", "READ.virtualization.EsxiConsole": "Read a 'virtualization.EsxiConsole' resource.", "UPDATE.virtualization.EsxiConsole": "Update a 'virtualization.EsxiConsole' resource.", "READ.virtualization.Host": "Read a 'virtualization.Host' resource.", "UPDATE.virtualization.Host": "Update a 'virtualization.Host' resource.", "CREATE.virtualization.VirtualMachine": "Create a 'virtualization.VirtualMachine' resource.", "DELETE.virtualization.VirtualMachine": "Delete a 'virtualization.VirtualMachine' resource.", "READ.virtualization.VirtualMachine": "Read a 'virtualization.VirtualMachine' resource.", "UPDATE.virtualization.VirtualMachine": "Update a 'virtualization.VirtualMachine' resource.", "READ.virtualization.VmwareCluster": "Read a 'virtualization.VmwareCluster' resource.", "UPDATE.virtualization.VmwareCluster": "Update a 'virtualization.VmwareCluster' resource.", "READ.virtualization.VmwareDatacenter": "Read a 'virtualization.VmwareDatacenter' resource.", "UPDATE.virtualization.VmwareDatacenter": "Update a 'virtualization.VmwareDatacenter' resource.", "READ.virtualization.VmwareDatastore": "Read a 'virtualization.VmwareDatastore' resource.", "UPDATE.virtualization.VmwareDatastore": "Update a 'virtualization.VmwareDatastore' resource.", "READ.virtualization.VmwareDatastoreCluster": "Read a 'virtualization.VmwareDatastoreCluster' resource.", "UPDATE.virtualization.VmwareDatastoreCluster": "Update a 'virtualization.VmwareDatastoreCluster' resource.", "READ.virtualization.VmwareDistributedNetwork": "Read a 'virtualization.VmwareDistributedNetwork' resource.", "UPDATE.virtualization.VmwareDistributedNetwork": "Update a 'virtualization.VmwareDistributedNetwork' resource.", "READ.virtualization.VmwareDistributedSwitch": "Read a 'virtualization.VmwareDistributedSwitch' resource.", "UPDATE.virtualization.VmwareDistributedSwitch": "Update a 'virtualization.VmwareDistributedSwitch' resource.", "READ.virtualization.VmwareFolder": "Read a 'virtualization.VmwareFolder' resource.", "UPDATE.virtualization.VmwareFolder": "Update a 'virtualization.VmwareFolder' resource.", "READ.virtualization.VmwareHost": "Read a 'virtualization.VmwareHost' resource.", "UPDATE.virtualization.VmwareHost": "Update a 'virtualization.VmwareHost' resource.", "READ.virtualization.VmwareHostGpu": "Read a 'virtualization.VmwareHostGpu' resource.", "READ.virtualization.VmwareKernelNetwork": "Read a 'virtualization.VmwareKernelNetwork' resource.", "UPDATE.virtualization.VmwareKernelNetwork": "Update a 'virtualization.VmwareKernelNetwork' resource.", "READ.virtualization.VmwareNetwork": "Read a 'virtualization.VmwareNetwork' resource.", "UPDATE.virtualization.VmwareNetwork": "Update a 'virtualization.VmwareNetwork' resource.", "READ.virtualization.VmwarePhysicalNetworkInterface": "Read a 'virtualization.VmwarePhysicalNetworkInterface' resource.", "UPDATE.virtualization.VmwarePhysicalNetworkInterface": "Update a 'virtualization.VmwarePhysicalNetworkInterface' resource.", "READ.virtualization.VmwareProactiveHa": "Read a 'virtualization.VmwareProactiveHa' resource.", "READ.virtualization.VmwareUplinkPort": "Read a 'virtualization.VmwareUplinkPort' resource.", "UPDATE.virtualization.VmwareUplinkPort": "Update a 'virtualization.VmwareUplinkPort' resource.", "READ.virtualization.VmwareVcenter": "Read a 'virtualization.VmwareVcenter' resource.", "READ.virtualization.VmwareVirtualDisk": "Read a 'virtualization.VmwareVirtualDisk' resource.", "UPDATE.virtualization.VmwareVirtualDisk": "Update a 'virtualization.VmwareVirtualDisk' resource.", "READ.virtualization.VmwareVirtualMachine": "Read a 'virtualization.VmwareVirtualMachine' resource.", "UPDATE.virtualization.VmwareVirtualMachine": "Update a 'virtualization.VmwareVirtualMachine' resource.", "READ.virtualization.VmwareVirtualMachineGpu": "Read a 'virtualization.VmwareVirtualMachineGpu' resource.", "READ.virtualization.VmwareVirtualMachineSnapshot": "Read a 'virtualization.VmwareVirtualMachineSnapshot' resource.", "UPDATE.virtualization.VmwareVirtualMachineSnapshot": "Update a 'virtualization.VmwareVirtualMachineSnapshot' resource.", "READ.virtualization.VmwareVirtualNetworkInterface": "Read a 'virtualization.VmwareVirtualNetworkInterface' resource.", "UPDATE.virtualization.VmwareVirtualNetworkInterface": "Update a 'virtualization.VmwareVirtualNetworkInterface' resource.", "READ.virtualization.VmwareVirtualSwitch": "Read a 'virtualization.VmwareVirtualSwitch' resource.", "UPDATE.virtualization.VmwareVirtualSwitch": "Update a 'virtualization.VmwareVirtualSwitch' resource.", "CREATE.vmedia.Policy": "Create a 'vmedia.Policy' resource.", "DELETE.vmedia.Policy": "Delete a 'vmedia.Policy' resource.", "READ.vmedia.Policy": "Read a 'vmedia.Policy' resource.", "UPDATE.vmedia.Policy": "Update a 'vmedia.Policy' resource.", "READ.vmedia.PolicyInventory": "Read a 'vmedia.PolicyInventory' resource.", "CREATE.vmrc.Console": "Create a 'vmrc.Console' resource.", "READ.vmrc.Console": "Read a 'vmrc.Console' resource.", "UPDATE.vmrc.Console": "Update a 'vmrc.Console' resource.", "CREATE.vnic.EthAdapterPolicy": "Create a 'vnic.EthAdapterPolicy' resource.", "DELETE.vnic.EthAdapterPolicy": "Delete a 'vnic.EthAdapterPolicy' resource.", "READ.vnic.EthAdapterPolicy": "Read a 'vnic.EthAdapterPolicy' resource.", "UPDATE.vnic.EthAdapterPolicy": "Update a 'vnic.EthAdapterPolicy' resource.", "READ.vnic.EthAdapterPolicyInventory": "Read a 'vnic.EthAdapterPolicyInventory' resource.", "CREATE.vnic.EthIf": "Create a 'vnic.EthIf' resource.", "DELETE.vnic.EthIf": "Delete a 'vnic.EthIf' resource.", "READ.vnic.EthIf": "Read a 'vnic.EthIf' resource.", "UPDATE.vnic.EthIf": "Update a 'vnic.EthIf' resource.", "READ.vnic.EthIfInventory": "Read a 'vnic.EthIfInventory' resource.", "CREATE.vnic.EthNetworkPolicy": "Create a 'vnic.EthNetworkPolicy' resource.", "DELETE.vnic.EthNetworkPolicy": "Delete a 'vnic.EthNetworkPolicy' resource.", "READ.vnic.EthNetworkPolicy": "Read a 'vnic.EthNetworkPolicy' resource.", "UPDATE.vnic.EthNetworkPolicy": "Update a 'vnic.EthNetworkPolicy' resource.", "READ.vnic.EthNetworkPolicyInventory": "Read a 'vnic.EthNetworkPolicyInventory' resource.", "CREATE.vnic.EthQosPolicy": "Create a 'vnic.EthQosPolicy' resource.", "DELETE.vnic.EthQosPolicy": "Delete a 'vnic.EthQosPolicy' resource.", "READ.vnic.EthQosPolicy": "Read a 'vnic.EthQosPolicy' resource.", "UPDATE.vnic.EthQosPolicy": "Update a 'vnic.EthQosPolicy' resource.", "READ.vnic.EthQosPolicyInventory": "Read a 'vnic.EthQosPolicyInventory' resource.", "READ.vnic.EthVethInventory": "Read a 'vnic.EthVethInventory' resource.", "READ.vnic.EthVnicInventory": "Read a 'vnic.EthVnicInventory' resource.", "CREATE.vnic.FcAdapterPolicy": "Create a 'vnic.FcAdapterPolicy' resource.", "DELETE.vnic.FcAdapterPolicy": "Delete a 'vnic.FcAdapterPolicy' resource.", "READ.vnic.FcAdapterPolicy": "Read a 'vnic.FcAdapterPolicy' resource.", "UPDATE.vnic.FcAdapterPolicy": "Update a 'vnic.FcAdapterPolicy' resource.", "READ.vnic.FcAdapterPolicyInventory": "Read a 'vnic.FcAdapterPolicyInventory' resource.", "CREATE.vnic.FcIf": "Create a 'vnic.FcIf' resource.", "DELETE.vnic.FcIf": "Delete a 'vnic.FcIf' resource.", "READ.vnic.FcIf": "Read a 'vnic.FcIf' resource.", "UPDATE.vnic.FcIf": "Update a 'vnic.FcIf' resource.", "READ.vnic.FcIfInventory": "Read a 'vnic.FcIfInventory' resource.", "CREATE.vnic.FcNetworkPolicy": "Create a 'vnic.FcNetworkPolicy' resource.", "DELETE.vnic.FcNetworkPolicy": "Delete a 'vnic.FcNetworkPolicy' resource.", "READ.vnic.FcNetworkPolicy": "Read a 'vnic.FcNetworkPolicy' resource.", "UPDATE.vnic.FcNetworkPolicy": "Update a 'vnic.FcNetworkPolicy' resource.", "READ.vnic.FcNetworkPolicyInventory": "Read a 'vnic.FcNetworkPolicyInventory' resource.", "CREATE.vnic.FcQosPolicy": "Create a 'vnic.FcQosPolicy' resource.", "DELETE.vnic.FcQosPolicy": "Delete a 'vnic.FcQosPolicy' resource.", "READ.vnic.FcQosPolicy": "Read a 'vnic.FcQosPolicy' resource.", "UPDATE.vnic.FcQosPolicy": "Update a 'vnic.FcQosPolicy' resource.", "READ.vnic.FcQosPolicyInventory": "Read a 'vnic.FcQosPolicyInventory' resource.", "READ.vnic.FcVethInventory": "Read a 'vnic.FcVethInventory' resource.", "READ.vnic.FcVhbaPolicyInventory": "Read a 'vnic.FcVhbaPolicyInventory' resource.", "CREATE.vnic.IscsiAdapterPolicy": "Create a 'vnic.IscsiAdapterPolicy' resource.", "DELETE.vnic.IscsiAdapterPolicy": "Delete a 'vnic.IscsiAdapterPolicy' resource.", "READ.vnic.IscsiAdapterPolicy": "Read a 'vnic.IscsiAdapterPolicy' resource.", "UPDATE.vnic.IscsiAdapterPolicy": "Update a 'vnic.IscsiAdapterPolicy' resource.", "READ.vnic.IscsiAdapterPolicyInventory": "Read a 'vnic.IscsiAdapterPolicyInventory' resource.", "CREATE.vnic.IscsiBootPolicy": "Create a 'vnic.IscsiBootPolicy' resource.", "DELETE.vnic.IscsiBootPolicy": "Delete a 'vnic.IscsiBootPolicy' resource.", "READ.vnic.IscsiBootPolicy": "Read a 'vnic.IscsiBootPolicy' resource.", "UPDATE.vnic.IscsiBootPolicy": "Update a 'vnic.IscsiBootPolicy' resource.", "READ.vnic.IscsiBootPolicyInventory": "Read a 'vnic.IscsiBootPolicyInventory' resource.", "CREATE.vnic.IscsiStaticTargetPolicy": "Create a 'vnic.IscsiStaticTargetPolicy' resource.", "DELETE.vnic.IscsiStaticTargetPolicy": "Delete a 'vnic.IscsiStaticTargetPolicy' resource.", "READ.vnic.IscsiStaticTargetPolicy": "Read a 'vnic.IscsiStaticTargetPolicy' resource.", "UPDATE.vnic.IscsiStaticTargetPolicy": "Update a 'vnic.IscsiStaticTargetPolicy' resource.", "READ.vnic.IscsiStaticTargetPolicyInventory": "Read a 'vnic.IscsiStaticTargetPolicyInventory' resource.", "CREATE.vnic.LanConnectivityPolicy": "Create a 'vnic.LanConnectivityPolicy' resource.", "DELETE.vnic.LanConnectivityPolicy": "Delete a 'vnic.LanConnectivityPolicy' resource.", "READ.vnic.LanConnectivityPolicy": "Read a 'vnic.LanConnectivityPolicy' resource.", "UPDATE.vnic.LanConnectivityPolicy": "Update a 'vnic.LanConnectivityPolicy' resource.", "READ.vnic.LanConnectivityPolicyInventory": "Read a 'vnic.LanConnectivityPolicyInventory' resource.", "READ.vnic.LanSettings": "Read a 'vnic.LanSettings' resource.", "READ.vnic.LcpStatus": "Read a 'vnic.LcpStatus' resource.", "CREATE.vnic.SanConnectivityPolicy": "Create a 'vnic.SanConnectivityPolicy' resource.", "DELETE.vnic.SanConnectivityPolicy": "Delete a 'vnic.SanConnectivityPolicy' resource.", "READ.vnic.SanConnectivityPolicy": "Read a 'vnic.SanConnectivityPolicy' resource.", "UPDATE.vnic.SanConnectivityPolicy": "Update a 'vnic.SanConnectivityPolicy' resource.", "READ.vnic.SanConnectivityPolicyInventory": "Read a 'vnic.SanConnectivityPolicyInventory' resource.", "READ.vnic.SanSettings": "Read a 'vnic.SanSettings' resource.", "READ.vnic.ScpStatus": "Read a 'vnic.ScpStatus' resource.", "READ.vnic.ServiceEthIf": "Read a 'vnic.ServiceEthIf' resource.", "READ.vnic.ServiceEthIfInventory": "Read a 'vnic.ServiceEthIfInventory' resource.", "CREATE.vnic.VhbaTemplate": "Create a 'vnic.VhbaTemplate' resource.", "DELETE.vnic.VhbaTemplate": "Delete a 'vnic.VhbaTemplate' resource.", "READ.vnic.VhbaTemplate": "Read a 'vnic.VhbaTemplate' resource.", "UPDATE.vnic.VhbaTemplate": "Update a 'vnic.VhbaTemplate' resource.", "READ.vnic.VifIdPool": "Read a 'vnic.VifIdPool' resource.", "CREATE.vnic.VnicTemplate": "Create a 'vnic.VnicTemplate' resource.", "DELETE.vnic.VnicTemplate": "Delete a 'vnic.VnicTemplate' resource.", "READ.vnic.VnicTemplate": "Read a 'vnic.VnicTemplate' resource.", "UPDATE.vnic.VnicTemplate": "Update a 'vnic.VnicTemplate' resource.", "CREATE.vrf.Vrf": "Create a 'vrf.Vrf' resource.", "DELETE.vrf.Vrf": "Delete a 'vrf.Vrf' resource.", "READ.vrf.Vrf": "Read a 'vrf.Vrf' resource.", "UPDATE.vrf.Vrf": "Update a 'vrf.Vrf' resource.", "CREATE.webhook.Endpoint": "Create a 'webhook.Endpoint' resource.", "DELETE.webhook.Endpoint": "Delete a 'webhook.Endpoint' resource.", "READ.webhook.Endpoint": "Read a 'webhook.Endpoint' resource.", "UPDATE.webhook.Endpoint": "Update a 'webhook.Endpoint' resource.", "CREATE.webhook.Schema": "Create a 'webhook.Schema' resource.", "DELETE.webhook.Schema": "Delete a 'webhook.Schema' resource.", "READ.webhook.Schema": "Read a 'webhook.Schema' resource.", "UPDATE.webhook.Schema": "Update a 'webhook.Schema' resource.", "CREATE.workflow.AnsibleBatchExecutor": "Create a 'workflow.AnsibleBatchExecutor' resource.", "DELETE.workflow.AnsibleBatchExecutor": "Delete a 'workflow.AnsibleBatchExecutor' resource.", "READ.workflow.AnsibleBatchExecutor": "Read a 'workflow.AnsibleBatchExecutor' resource.", "UPDATE.workflow.AnsibleBatchExecutor": "Update a 'workflow.AnsibleBatchExecutor' resource.", "CREATE.workflow.BatchApiExecutor": "Create a 'workflow.BatchApiExecutor' resource.", "DELETE.workflow.BatchApiExecutor": "Delete a 'workflow.BatchApiExecutor' resource.", "READ.workflow.BatchApiExecutor": "Read a 'workflow.BatchApiExecutor' resource.", "UPDATE.workflow.BatchApiExecutor": "Update a 'workflow.BatchApiExecutor' resource.", "READ.workflow.Catalog": "Read a 'workflow.Catalog' resource.", "CREATE.workflow.CatalogItemDefinition": "Create a 'workflow.CatalogItemDefinition' resource.", "DELETE.workflow.CatalogItemDefinition": "Delete a 'workflow.CatalogItemDefinition' resource.", "READ.workflow.CatalogItemDefinition": "Read a 'workflow.CatalogItemDefinition' resource.", "UPDATE.workflow.CatalogItemDefinition": "Update a 'workflow.CatalogItemDefinition' resource.", "CREATE.workflow.CatalogServiceRequest": "Create a 'workflow.CatalogServiceRequest' resource.", "DELETE.workflow.CatalogServiceRequest": "Delete a 'workflow.CatalogServiceRequest' resource.", "READ.workflow.CatalogServiceRequest": "Read a 'workflow.CatalogServiceRequest' resource.", "UPDATE.workflow.CatalogServiceRequest": "Update a 'workflow.CatalogServiceRequest' resource.", "CREATE.workflow.CustomDataTypeDefinition": "Create a 'workflow.CustomDataTypeDefinition' resource.", "DELETE.workflow.CustomDataTypeDefinition": "Delete a 'workflow.CustomDataTypeDefinition' resource.", "READ.workflow.CustomDataTypeDefinition": "Read a 'workflow.CustomDataTypeDefinition' resource.", "UPDATE.workflow.CustomDataTypeDefinition": "Update a 'workflow.CustomDataTypeDefinition' resource.", "CREATE.workflow.ErrorResponseHandler": "Create a 'workflow.ErrorResponseHandler' resource.", "DELETE.workflow.ErrorResponseHandler": "Delete a 'workflow.ErrorResponseHandler' resource.", "READ.workflow.ErrorResponseHandler": "Read a 'workflow.ErrorResponseHandler' resource.", "UPDATE.workflow.ErrorResponseHandler": "Update a 'workflow.ErrorResponseHandler' resource.", "CREATE.workflow.PowerShellBatchApiExecutor": "Create a 'workflow.PowerShellBatchApiExecutor' resource.", "DELETE.workflow.PowerShellBatchApiExecutor": "Delete a 'workflow.PowerShellBatchApiExecutor' resource.", "READ.workflow.PowerShellBatchApiExecutor": "Read a 'workflow.PowerShellBatchApiExecutor' resource.", "UPDATE.workflow.PowerShellBatchApiExecutor": "Update a 'workflow.PowerShellBatchApiExecutor' resource.", "CREATE.workflow.RollbackWorkflow": "Create a 'workflow.RollbackWorkflow' resource.", "DELETE.workflow.RollbackWorkflow": "Delete a 'workflow.RollbackWorkflow' resource.", "READ.workflow.RollbackWorkflow": "Read a 'workflow.RollbackWorkflow' resource.", "UPDATE.workflow.RollbackWorkflow": "Update a 'workflow.RollbackWorkflow' resource.", "CREATE.workflow.ServiceItemActionDefinition": "Create a 'workflow.ServiceItemActionDefinition' resource.", "DELETE.workflow.ServiceItemActionDefinition": "Delete a 'workflow.ServiceItemActionDefinition' resource.", "READ.workflow.ServiceItemActionDefinition": "Read a 'workflow.ServiceItemActionDefinition' resource.", "UPDATE.workflow.ServiceItemActionDefinition": "Update a 'workflow.ServiceItemActionDefinition' resource.", "CREATE.workflow.ServiceItemActionInstance": "Create a 'workflow.ServiceItemActionInstance' resource.", "DELETE.workflow.ServiceItemActionInstance": "Delete a 'workflow.ServiceItemActionInstance' resource.", "READ.workflow.ServiceItemActionInstance": "Read a 'workflow.ServiceItemActionInstance' resource.", "UPDATE.workflow.ServiceItemActionInstance": "Update a 'workflow.ServiceItemActionInstance' resource.", "READ.workflow.ServiceItemAttribute": "Read a 'workflow.ServiceItemAttribute' resource.", "CREATE.workflow.ServiceItemDefinition": "Create a 'workflow.ServiceItemDefinition' resource.", "DELETE.workflow.ServiceItemDefinition": "Delete a 'workflow.ServiceItemDefinition' resource.", "READ.workflow.ServiceItemDefinition": "Read a 'workflow.ServiceItemDefinition' resource.", "UPDATE.workflow.ServiceItemDefinition": "Update a 'workflow.ServiceItemDefinition' resource.", "READ.workflow.ServiceItemHealthCheckDefinition": "Read a 'workflow.ServiceItemHealthCheckDefinition' resource.", "READ.workflow.ServiceItemHealthCheckExecution": "Read a 'workflow.ServiceItemHealthCheckExecution' resource.", "CREATE.workflow.ServiceItemInstance": "Create a 'workflow.ServiceItemInstance' resource.", "DELETE.workflow.ServiceItemInstance": "Delete a 'workflow.ServiceItemInstance' resource.", "READ.workflow.ServiceItemInstance": "Read a 'workflow.ServiceItemInstance' resource.", "UPDATE.workflow.ServiceItemInstance": "Update a 'workflow.ServiceItemInstance' resource.", "CREATE.workflow.ServiceItemOutput": "Create a 'workflow.ServiceItemOutput' resource.", "DELETE.workflow.ServiceItemOutput": "Delete a 'workflow.ServiceItemOutput' resource.", "READ.workflow.ServiceItemOutput": "Read a 'workflow.ServiceItemOutput' resource.", "UPDATE.workflow.ServiceItemOutput": "Update a 'workflow.ServiceItemOutput' resource.", "CREATE.workflow.SshBatchExecutor": "Create a 'workflow.SshBatchExecutor' resource.", "DELETE.workflow.SshBatchExecutor": "Delete a 'workflow.SshBatchExecutor' resource.", "READ.workflow.SshBatchExecutor": "Read a 'workflow.SshBatchExecutor' resource.", "UPDATE.workflow.SshBatchExecutor": "Update a 'workflow.SshBatchExecutor' resource.", "READ.workflow.TaskDebugLog": "Read a 'workflow.TaskDebugLog' resource.", "CREATE.workflow.TaskDefinition": "Create a 'workflow.TaskDefinition' resource.", "DELETE.workflow.TaskDefinition": "Delete a 'workflow.TaskDefinition' resource.", "READ.workflow.TaskDefinition": "Read a 'workflow.TaskDefinition' resource.", "UPDATE.workflow.TaskDefinition": "Update a 'workflow.TaskDefinition' resource.", "READ.workflow.TaskInfo": "Read a 'workflow.TaskInfo' resource.", "UPDATE.workflow.TaskInfo": "Update a 'workflow.TaskInfo' resource.", "READ.workflow.TaskMetadata": "Read a 'workflow.TaskMetadata' resource.", "CREATE.workflow.TemplateEvaluation": "Create a 'workflow.TemplateEvaluation' resource.", "READ.workflow.TemplateFunctionMeta": "Read a 'workflow.TemplateFunctionMeta' resource.", "CREATE.workflow.TemplateParser": "Create a 'workflow.TemplateParser' resource.", "CREATE.workflow.UiDisplayMetadata": "Create a 'workflow.UiDisplayMetadata' resource.", "DELETE.workflow.UiDisplayMetadata": "Delete a 'workflow.UiDisplayMetadata' resource.", "READ.workflow.UiDisplayMetadata": "Read a 'workflow.UiDisplayMetadata' resource.", "UPDATE.workflow.UiDisplayMetadata": "Update a 'workflow.UiDisplayMetadata' resource.", "CREATE.workflow.Variable": "Create a 'workflow.Variable' resource.", "DELETE.workflow.Variable": "Delete a 'workflow.Variable' resource.", "READ.workflow.Variable": "Read a 'workflow.Variable' resource.", "UPDATE.workflow.Variable": "Update a 'workflow.Variable' resource.", "CREATE.workflow.WorkflowDefinition": "Create a 'workflow.WorkflowDefinition' resource.", "DELETE.workflow.WorkflowDefinition": "Delete a 'workflow.WorkflowDefinition' resource.", "READ.workflow.WorkflowDefinition": "Read a 'workflow.WorkflowDefinition' resource.", "UPDATE.workflow.WorkflowDefinition": "Update a 'workflow.WorkflowDefinition' resource.", "CREATE.workflow.WorkflowInfo": "Create a 'workflow.WorkflowInfo' resource.", "DELETE.workflow.WorkflowInfo": "Delete a 'workflow.WorkflowInfo' resource.", "READ.workflow.WorkflowInfo": "Read a 'workflow.WorkflowInfo' resource.", "UPDATE.workflow.WorkflowInfo": "Update a 'workflow.WorkflowInfo' resource.", "READ.workflow.WorkflowMetadata": "Read a 'workflow.WorkflowMetadata' resource.", "CREATE.workload.Blueprint": "Create a 'workload.Blueprint' resource.", "DELETE.workload.Blueprint": "Delete a 'workload.Blueprint' resource.", "READ.workload.Blueprint": "Read a 'workload.Blueprint' resource.", "UPDATE.workload.Blueprint": "Update a 'workload.Blueprint' resource.", "CREATE.workload.ClearWorkloadTag": "Create a 'workload.ClearWorkloadTag' resource.", "DELETE.workload.ClearWorkloadTag": "Delete a 'workload.ClearWorkloadTag' resource.", "READ.workload.ClearWorkloadTag": "Read a 'workload.ClearWorkloadTag' resource.", "READ.workload.DeploymentInput": "Read a 'workload.DeploymentInput' resource.", "CREATE.workload.WorkloadDefinition": "Create a 'workload.WorkloadDefinition' resource.", "DELETE.workload.WorkloadDefinition": "Delete a 'workload.WorkloadDefinition' resource.", "READ.workload.WorkloadDefinition": "Read a 'workload.WorkloadDefinition' resource.", "UPDATE.workload.WorkloadDefinition": "Update a 'workload.WorkloadDefinition' resource.", "CREATE.workload.WorkloadDeployment": "Create a 'workload.WorkloadDeployment' resource.", "DELETE.workload.WorkloadDeployment": "Delete a 'workload.WorkloadDeployment' resource.", "READ.workload.WorkloadDeployment": "Read a 'workload.WorkloadDeployment' resource.", "UPDATE.workload.WorkloadDeployment": "Update a 'workload.WorkloadDeployment' resource.", "DELETE.workload.WorkloadInstance": "Delete a 'workload.WorkloadInstance' resource.", "READ.workload.WorkloadInstance": "Read a 'workload.WorkloadInstance' resource.", "UPDATE.workload.WorkloadInstance": "Update a 'workload.WorkloadInstance' resource.", "READ.workload.WorkloadMetadata": "Read a 'workload.WorkloadMetadata' resource.", "UPDATE.workload.WorkloadMetadata": "Update a 'workload.WorkloadMetadata' resource." } } } } } } }